Args:
    path: Configuration path as list of strings, e.g. ["firewall", "group"]

Use this instead of vyos_retrieve when a node has multiple
values (e.g. addresses on an interface).

Args:
    path: Configuration path, e.g.
        ["interfaces", "dummy", "dum0", "address"]

Returns true/false in the data field.

Args:
    path: Configuration path to check,
        e.g. ["service", "https", "api"]

Compares running config against saved config by default,
or against a specific revision number. Useful for previewing
changes before committing or reviewing what has drifted.

Args:
    rev: Optional revision number to compare against

Args:
    path: Command path as list of strings, e.g. ["interfaces", "ethernet"]

Applies commands with a 1-minute commit-confirm window and does NOT
confirm, so the router automatically rolls back. This is not a true
dry-run — the configuration is temporarily applied for up to 1 minute.

A successful response means the syntax is valid. An error means the
commands contain invalid syntax or paths.

Args:
    commands: List of config operations, each with 'op'
        ('set'/'delete') and 'path' (list of strings).
        Example: [{"op": "set", "path": ["firewall",
        "group", "network-group", "MY_GROUP"]}]

This is the safe default — changes auto-revert unless confirmed with vyos_confirm.

Args:
    commands: List of config operations, each with 'op'
        ('set'/'delete') and 'path' (list of strings).
        Example: [{"op": "set", "path": ["firewall",
        "group", "network-group", "MY_GROUP"]}]

Args:
    path: Command path, e.g. ["pki", "wireguard", "key-pair"]

Args:
    path: Command path, e.g. ["ip", "bgp", "192.0.2.11"]

Args:
    file: Path to config file on the router,
        e.g. "/config/test.config"

Provide either a file path on the router or an inline
config string (VyOS curly-brace format).

Args:
    file: Path to config file on the router
    string: Inline config in VyOS format, e.g.
        'interfaces { ethernet eth1 { description "test" } }'

WARNING: This will reboot the router. All active sessions
and traffic will be interrupted.

WARNING: This will shut down the router. The router will
need physical or out-of-band access to power back on.

Downloads and installs a new system image. This does not
reboot — the new image will be used on next boot.

Args:
    url: URL to the VyOS ISO image

WARNING: Cannot delete the currently running image.

Args:
    name: Image name, e.g. "1.4-rolling-202102280559"

Returns matching doc pages ranked by relevance. Use
vyos_docs_read to fetch the full content of a result.

Args:
    query: Search terms, e.g. "firewall group" or "nat hairpin"
    max_results: Maximum number of results to return (default 10)

Fetches the raw RST content from the VyOS docs repository.
Use vyos_docs_search to find the path for a topic.

Args:
    path: Doc path, e.g. "docs/configuration/firewall/groups.rst"