ExUtcp.Transports.Grpc.Gnmi (ex_utcp v0.3.2)

Copy Markdown View Source

gNMI (gRPC Network Management Interface) specific functionality.

This module provides specialized functions for network management operations using the gNMI protocol over gRPC.

Summary

Functions

Builds a gNMI path from components.

Performs a gNMI Capabilities operation to discover supported models.

Performs a gNMI Get operation to retrieve configuration or state data.

Parses a gNMI path into components.

Performs a gNMI Set operation to modify configuration.

Performs a gNMI Subscribe operation for real-time data streaming.

Validates gNMI paths for correctness.

Functions

build_path(origin, elements, target \\ "")

@spec build_path(String.t(), [String.t()], String.t()) :: String.t()

Builds a gNMI path from components.

capabilities(connection_pid, opts \\ [])

@spec capabilities(
  pid(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Performs a gNMI Capabilities operation to discover supported models.

get(connection_pid, paths, opts \\ [])

@spec get(pid(), [String.t()], keyword()) :: {:ok, map()} | {:error, term()}

Performs a gNMI Get operation to retrieve configuration or state data.

parse_path(path)

@spec parse_path(String.t()) :: {:ok, map()} | {:error, term()}

Parses a gNMI path into components.

set(connection_pid, updates, opts \\ [])

@spec set(pid(), [map()], keyword()) :: {:ok, map()} | {:error, term()}

Performs a gNMI Set operation to modify configuration.

subscribe(connection_pid, paths, opts \\ [])

@spec subscribe(pid(), [String.t()], keyword()) :: {:ok, [map()]} | {:error, term()}

Performs a gNMI Subscribe operation for real-time data streaming.

validate_paths(paths)

@spec validate_paths([String.t()]) :: {:ok, [String.t()]} | {:error, term()}

Validates gNMI paths for correctness.