acex-devkit 1.8.0__tar.gz → 1.10.0__tar.gz

{acex_devkit-1.8.0 → acex_devkit-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 1.8.0
+Version: 1.10.0
 Summary: ACE-X DevKit - Development kit for building ACE-X drivers and plugins
 License: AGPL-3.0
 Keywords: automation,devkit,sdk,drivers,plugins

{acex_devkit-1.8.0 → acex_devkit-1.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "1.8.0"
+version = "1.10.0"
 description = "ACE-X DevKit - Development kit for building ACE-X drivers and plugins"
 authors = ["Johan Lahti <johan.lahti@acebit.se>"]
 readme = "README.md"

{acex_devkit-1.8.0 → acex_devkit-1.10.0}/src/acex_devkit/drivers/base.py

@@ -1,6 +1,7 @@
 """Driver base classes for ACE-X network element drivers."""
 
 from abc import ABC, abstractmethod
+from contextlib import contextmanager
 from typing import Any, Dict
 
 from acex_devkit.models.node_response import NodeListItem
@@ -43,9 +44,9 @@ class RendererBase(ABC):
 class TransportBase(ABC):
     """Base class for device transport/communication.
 
-    Each method is self-contained — the driver decides internally
-    whether to open/close sessions per call, pool connections, or
-    make stateless requests.
+    Each method is self-contained, but transports may also expose
+    `session()` as a context manager so a caller can run multiple
+    operations against the same physical connection.
 
     Args:
         node: The node instance (identity, hostname, vendor, os, ned_id)
@@ -53,6 +54,16 @@ class TransportBase(ABC):
         **kwargs: Future use (credentials, options, etc.)
     """
 
+    @contextmanager
+    def session(self, connection: ManagementConnection, **kwargs):
+        """Open a reusable session for multiple ops on one device.
+
+        Default is a no-op: methods continue to open/close per call.
+        Drivers that benefit from connection reuse override this to
+        hold a single connection open for the duration of the block.
+        """
+        yield self
+
     @abstractmethod
     def get_config(self, node: NodeListItem, connection: ManagementConnection, **kwargs) -> str:
         """Fetch the full running configuration from a device."""
@@ -67,6 +78,14 @@ class TransportBase(ABC):
         """Run arbitrary commands and return output per command. Opt-in per driver."""
         raise NotImplementedError(f"{self.__class__.__name__} does not implement execute()")
 
+    def get_lldp_neighbors(self, node: NodeListItem, connection: ManagementConnection, **kwargs) -> list[dict]:
+        """Fetch LLDP/CDP neighbor table from a device.
+
+        Returns list of dicts with keys:
+            local_interface, remote_device, remote_interface, discovery_protocol
+        """
+        raise NotImplementedError(f"{self.__class__.__name__} does not implement get_lldp_neighbors()")
+
 
 class NetworkElementDriver:
     """Base class for network element drivers.

{acex_devkit-1.8.0 → acex_devkit-1.10.0}/src/acex_devkit/models/composed_configuration.py

@@ -709,6 +709,108 @@ class Services(BaseModel):
     http: Optional[AttributeValue[bool]] = None # for webgui access
     https: Optional[AttributeValue[bool]] = None # for webgui access
 
+class NetflowFormat(str, Enum):
+    IPFIX = "IPFIX"
+    NETFLOW_V9 = "NetFlow v9"
+    NETFLOW_V5 = "NetFlow v5"
+
+class NetflowRecordIpv4Match(BaseModel):
+    # Leaf-level ipv4 matches (Cisco style "match ipv4 <field>"). True = match this field, False = No. None = Ignore the field
+    netflow_record: Optional[AttributeValue[str]] = None # Reference to parent record, used for easier access in config component
+    dscp: Optional[AttributeValue[bool]] = None
+    fragmentation: Optional[AttributeValue[bool]] = None
+    header_length: Optional[AttributeValue[bool]] = None
+    id: Optional[AttributeValue[bool]] = None
+    length: Optional[AttributeValue[bool]] = None
+    option: Optional[AttributeValue[bool]] = None
+    precedence: Optional[AttributeValue[bool]] = None
+    protocol: Optional[AttributeValue[bool]] = None
+    section: Optional[AttributeValue[str]] = None
+    tos: Optional[AttributeValue[bool]] = None
+    total_length: Optional[AttributeValue[bool]] = None
+    ttl: Optional[AttributeValue[bool]] = None
+    version: Optional[AttributeValue[bool]] = None
+
+class NetflowRecordAttributes(BaseModel): # Cisco flow record
+    match_ipv4: Optional[NetflowRecordIpv4Match] = None
+    #match_ipv4: Optional[Dict[str, NetflowRecordIpv4Match]] = {}
+    application_name: Optional[AttributeValue[bool]] = None
+
+    # Escape hatch for vendor-specific match knobs not yet modeled
+    match_vendor_specific: Optional[AttributeValue[Dict[str, Any]]] = None # keeping a flexible option if needed. Not advertised to users.
+
+    collect_timestamp_absolute_first: Optional[AttributeValue[bool]] = None
+    collect_timestamp_absolute_last: Optional[AttributeValue[bool]] = None
+
+class NetflowCollectorAttributes(BaseModel): # Cisco flow monitor
+    cache_inactive: Optional[AttributeValue[int]] = None
+    cache_active: Optional[AttributeValue[int]] = None
+    interfaces: Optional[Dict[str, Reference]] = {} # allow for disabling netflow on specific interfaces
+
+class NetflowExporterOptions(BaseModel):
+    # Mostly timeouts atm
+    interface_table_timeout: Optional[AttributeValue[int]] = None
+    vrf_table_timeout: Optional[AttributeValue[int]] = None
+    sampler_table_timeout: Optional[AttributeValue[int]] = None
+    application_table_timeout: Optional[AttributeValue[int]] = None
+    application_attributes_timeout: Optional[AttributeValue[int]] = None
+    netflow_exporter: Optional[AttributeValue[str]] = None # Reference to parent exporter, used for easier access in config component
+
+class NetflowExporterAttributes(ContainerEntry, BaseModel): # Cisco flow exporter
+    identity_fields: ClassVar[tuple[str, ...]] = ("address",)
+    address: Optional[AttributeValue[str]] = None
+    port: Optional[AttributeValue[int]] = None
+    format: Optional[AttributeValue[NetflowFormat]] = None
+    source_interface: Optional[Reference] = None
+    network_instance: Optional[AttributeValue[str]] = None
+    options: Optional[NetflowExporterOptions] = None
+
+class NetflowGlobalConfigAttributes(BaseModel):
+    enabled: Optional[AttributeValue[bool]] = None
+    version: Optional[AttributeValue[int]] = None
+
+class Netflow(BaseModel):
+    config: Optional[NetflowGlobalConfigAttributes] = None
+    records: Optional[Dict[str, NetflowRecordAttributes]] = {}
+    exporters: Optional[Dict[str, NetflowExporterAttributes]] = {}
+    collectors: Optional[Dict[str, NetflowCollectorAttributes]] = {}
+
+class SflowMonitoringAttributes(BaseModel): ...
+
+class SflowForwardingAttributes(BaseModel): ... # collector?
+
+class SflowCollectorAttributes(ContainerEntry, BaseModel):
+    identity_fields: ClassVar[tuple[str, ...]] = ("address",)
+    address: Optional[AttributeValue[str]] = None # Destination IP address of the sFlow collector
+    port: Optional[AttributeValue[int]] = None # UDP
+    source_address: Optional[AttributeValue[str]] = None 
+    network_instance: Optional[AttributeValue[str]] = None # VRF
+    interfaces: Optional[Dict[str, Reference]] = {} # allow for disabling sflow on specific interfaces
+
+class SfloGlobalConfigAttributes(BaseModel):
+    enabled: Optional[AttributeValue[bool]] = None
+    #version: Optional[AttributeValue[int]] = None
+    dscp: Optional[AttributeValue[int]] = None # range: 0..63 
+    sample_size: Optional[AttributeValue[int]] = None # Sets the maximum number of bytes to be copied from a sampled packet (content within one specific sample of a packet).
+    polling_interval: Optional[AttributeValue[int]] = None # seconds
+    ingress_sampling_rate: Optional[AttributeValue[int]] = None # sampling rate is 1/N packets. An implementation may implement the sampling rate as a statistical average, rather than a strict periodic sampling.
+    egress_sampling_rate: Optional[AttributeValue[int]] = None  # sampling rate is 1/N packets. An implementation may implement the sampling rate as a statistical average, rather than a strict periodic sampling.
+
+class Sflow(BaseModel):
+    #enabled: Optional[AttributeValue[bool]] = None
+    #version: Optional[AttributeValue[int]] = None
+    #dscp: Optional[AttributeValue[int]] = None # range: 0..63 
+    #sample_size: Optional[AttributeValue[int]] = None
+    #polling_interval: Optional[AttributeValue[int]] = None
+    #ingress_sampling_rate: Optional[AttributeValue[int]] = None
+    #egress_sampling_rate: Optional[AttributeValue[int]] = None
+    collector: Optional[Dict[str, SflowCollectorAttributes]] = {}
+    # Similar structure to Netflow can be implemented here for sFlow-specific attributes
+
+class Sampling(BaseModel):
+    netflow: Optional[Netflow] = Netflow()
+    #sflow: Optional[Sflow] = Sflow() # Sflow can be added in the future, similar structure to Netflow
+
 class System(BaseModel):
     config: SystemConfig = SystemConfig()
     aaa: Optional[TripleA] = TripleA()
@@ -739,7 +841,7 @@ class ComposedConfiguration(BaseModel):
     interfaces: Dict[str, InterfaceType] = {}
     network_instances: Dict[str, NetworkInstance] = {"global": NetworkInstance(name="global")}
     stp: Optional[SpanningTree] = SpanningTree()
-
+    sampling: Optional[Sampling] = Sampling()
 
 """
 GUIDELINES FOR COMPOSED CONFIGURATION: