CLI Extension via Definition File Translation

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Network devices often restrict third parties from extending their Command Line Interface (CLI) due to proprietary internal development tools and interfaces, limiting the ability to add custom commands without exposing internal interfaces or tools.

Innovation Solution

A definition file in a format like YAML or JSON is used to extend the CLI, allowing third parties to define vendor information, daemons, modes, and commands separately from the internal interface, with an agent processing this file to translate and integrate the extensions into the CLI data structure, enabling seamless execution of new commands without requiring access to proprietary tools.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Adaptability or versatility

If the company exposes internal interface and internal definition to third parties, then third parties can extend the CLI with custom commands, but the internal interface integrity and security are compromised

Engineering Contradiction:

ImproveCLI extensibilityVSAvoidinternal interface integrity

Core Design Contradiction:

Adaptability or versatilityVSReliability

Solution Approach 1:

The system segments the CLI extension functionality by separating the internal interface (used by developers) from the external interface (used by third parties). The external interface accepts simplified definition files that define vendor information, daemons, modes, and commands without exposing internal data structures. This segmentation allows third-party extension while preserving internal interface integrity.

Inventive Principle:

Principle #1Segmentation

Solution Approach 2:

An agent acts as an intermediary between the external definition files and the internal CLI data structure. The agent processes the external interface inputs, translates them into internal interface-compatible formats, and integrates them into the existing CLI. This intermediary layer shields the internal interface from direct external access while enabling extension functionality.

Inventive Principle:

Principle #24Intermediary (Mediator)

2Adaptability or versatility

If the company provides full internal development tools to third parties, then third parties can create comprehensive CLI extensions, but the complexity and difficulty of use increases significantly

Engineering Contradiction:

ImproveCLI extension capabilityVSAvoidextension implementation difficulty

Core Design Contradiction:

Adaptability or versatilityVSEase of operation

Solution Approach 1:

The system extracts only the essential elements needed for CLI extension (vendor information, daemons, modes, commands) and presents them through a simplified external interface. Third parties interact with this extracted subset rather than the full internal development toolset, significantly reducing complexity while maintaining extension capability.

Inventive Principle:

Principle #2Taking out (Extraction)

Solution Approach 2:

Instead of requiring third parties to use the internal interface directly, the system creates a simplified copy or representation of the necessary extension elements through definition files. These files contain the essential information needed to extend the CLI without replicating the full internal development environment.

Inventive Principle:

Principle #26Copying

3Adaptability or versatility

If the company allows third parties to modify internal CLI data structures, then custom functionality is achieved, but compatibility and stability are compromised

Engineering Contradiction:

Improvecustom command functionalityVSAvoidCLI data structure stability

Core Design Contradiction:

Adaptability or versatilityVSStability of the object's composition

Solution Approach 1:

The system performs preliminary action by processing and validating third-party extension definitions before they are integrated into the internal CLI data structure. The agent validates the definition files, translates them into appropriate internal formats, and ensures compatibility with existing structures before integration, preventing destabilizing modifications.

Inventive Principle:

Principle #10Preliminary action

Solution Approach 2:

The agent serves as an intermediary that mediates between third-party extension requests and the internal CLI data structure. It translates external definition files into internal interface-compatible formats and manages the integration process, ensuring that modifications to the CLI data structure are controlled, validated, and compatible with existing stability requirements.

Inventive Principle:

Principle #24Intermediary (Mediator)

Data Source

PatentUS11494207B2Command line interface extension process

Publication Date: 2022.11.08 ARISTA NETWORKS INC

AI summary

In some embodiments, a method or processing a command line interface is provided. The method parses a definition file for extending a command line interface (CLI) with an extension. The definition file is processed through an external interface that is different from an internal interface used to develop the CLI. The method translates a definition from the definition file to an internal structure supported by the internal interface. The translated definition implements the extension in the CLI. The internal structure is added to a data structure for the CLI where a command set of the CLI is extended to perform a command that is defined by the definition.