[DRAFT] ND4.2 Fabric Module Support for iBGP and eBGP Fabrics

plugins/module_utils/common/exceptions.py

@@ -1,6 +1,5 @@
-# -*- coding: utf-8 -*-
-
 # Copyright: (c) 2026, Allen Robel (@arobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Gaspard Micol (@gmicol) <gmicol@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
@@ -16,10 +15,6 @@
 # fmt: on
 # isort: on
 
-# pylint: disable=invalid-name
-__metaclass__ = type
-# pylint: enable=invalid-name
-
 from typing import Any, Optional
 
 from ansible_collections.cisco.nd.plugins.module_utils.common.pydantic_compat import (
@@ -144,3 +139,11 @@ def to_dict(self) -> dict[str, Any]:
         - None
         """
         return self.error_data.model_dump(exclude_none=True)
+
+
+class NDStateMachineError(Exception):
+    """
+    Raised when NDStateMachine is failing.
+    """
+
+    pass

plugins/module_utils/common/log.py

@@ -1,15 +1,9 @@
-# -*- coding: utf-8 -*-
-
 # Copyright: (c) 2026, Allen Robel (@arobel) <arobel@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
 
-# pylint: disable=invalid-name
-__metaclass__ = type
-# pylint: enable=invalid-name
-
 import json
 import logging
 from enum import Enum

plugins/module_utils/common/pydantic_compat.py

@@ -1,6 +1,5 @@
-# -*- coding: utf-8 -*-
-
 # Copyright: (c) 2026, Allen Robel (@arobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Gaspard Micol (@gmicol) <gmicol@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
@@ -34,10 +33,6 @@
 # fmt: on
 # isort: on
 
-# pylint: disable=invalid-name
-__metaclass__ = type
-# pylint: enable=invalid-name
-
 import traceback
 from typing import TYPE_CHECKING, Any, Callable, Union
 
@@ -51,11 +46,16 @@
         Field,
         PydanticExperimentalWarning,
         StrictBool,
+        SecretStr,
         ValidationError,
         field_serializer,
+        model_serializer,
         field_validator,
         model_validator,
         validator,
+        computed_field,
+        FieldSerializationInfo,
+        SerializationInfo,
     )
 
     HAS_PYDANTIC = True  # pylint: disable=invalid-name
@@ -71,11 +71,16 @@
             Field,
             PydanticExperimentalWarning,
             StrictBool,
+            SecretStr,
             ValidationError,
             field_serializer,
+            model_serializer,
             field_validator,
             model_validator,
             validator,
+            computed_field,
+            FieldSerializationInfo,
+            SerializationInfo,
         )
     except ImportError:
         HAS_PYDANTIC = False  # pylint: disable=invalid-name
@@ -127,6 +132,15 @@ def decorator(func):
 
             return decorator
 
+        # Fallback: model_serializer decorator that does nothing
+        def model_serializer(*args, **kwargs):  # pylint: disable=unused-argument
+            """Pydantic model_serializer fallback when pydantic is not available."""
+
+            def decorator(func):
+                return func
+
+            return decorator
+
         # Fallback: field_validator decorator that does nothing
         def field_validator(*args, **kwargs) -> Callable[..., Any]:  # pylint: disable=unused-argument,invalid-name
             """Pydantic field_validator fallback when pydantic is not available."""
@@ -136,6 +150,15 @@ def decorator(func):
 
             return decorator
 
+        # Fallback: computed_field decorator that does nothing
+        def computed_field(*args, **kwargs):  # pylint: disable=unused-argument
+            """Pydantic computed_field fallback when pydantic is not available."""
+
+            def decorator(func):
+                return func
+
+            return decorator
+
         # Fallback: AfterValidator that returns the function unchanged
         def AfterValidator(func):  # pylint: disable=invalid-name
             """Pydantic AfterValidator fallback when pydantic is not available."""
@@ -152,6 +175,9 @@ def BeforeValidator(func):  # pylint: disable=invalid-name
         # Fallback: StrictBool
         StrictBool = bool
 
+        # Fallback: SecretStr
+        SecretStr = str
+
         # Fallback: ValidationError
         class ValidationError(Exception):
             """
@@ -183,6 +209,20 @@ def decorator(func):
 
             return decorator
 
+        # Fallback: FieldSerializationInfo placeholder class that does nothing
+        class FieldSerializationInfo:
+            """Pydantic FieldSerializationInfo fallback when pydantic is not available."""
+
+            def __init__(self, **kwargs):
+                pass
+
+        # Fallback: SerializationInfo placeholder class that does nothing
+        class SerializationInfo:
+            """Pydantic SerializationInfo fallback when pydantic is not available."""
+
+            def __init__(self, **kwargs):
+                pass
+
     else:
         HAS_PYDANTIC = True  # pylint: disable=invalid-name
         PYDANTIC_IMPORT_ERROR = None  # pylint: disable=invalid-name
@@ -234,10 +274,15 @@ def main():
     "PYDANTIC_IMPORT_ERROR",
     "PydanticExperimentalWarning",
     "StrictBool",
+    "SecretStr",
     "ValidationError",
     "field_serializer",
+    "model_serializer",
     "field_validator",
     "model_validator",
     "require_pydantic",
     "validator",
+    "computed_field",
+    "FieldSerializationInfo",
+    "SerializationInfo",
 ]

plugins/module_utils/constants.py

@@ -1,13 +1,49 @@
-# -*- coding: utf-8 -*-
-
 # Copyright: (c) 2022, Akini Ross (@akinross) <akinross@cisco.com>
 # Copyright: (c) 2024, Gaspard Micol (@gmicol) <gmicol@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
 
-__metaclass__ = type
+from typing import Dict
+from types import MappingProxyType
+from copy import deepcopy
+
+
+class NDConstantMapping:
+    def __init__(self, data: Dict):
+        self.data = data
+        self.new_dict = deepcopy(data)
+        for k, v in data.items():
+            self.new_dict[v] = k
+        self.new_dict = MappingProxyType(self.new_dict)
+
+    def get_dict(self):
+        return self.new_dict
+
+    def get_original_data(self):
+        return list(self.data.keys())
+
+
+from typing import Dict
+from types import MappingProxyType
+from copy import deepcopy
+
+
+class NDConstantMapping(Dict):
+    def __init__(self, data: Dict):
+        self.data = data
+        self.new_dict = deepcopy(data)
+        for k, v in data.items():
+            self.new_dict[v] = k
+        self.new_dict = MappingProxyType(self.new_dict)
+
+    def get_dict(self):
+        return self.new_dict
+
+    def get_original_data(self):
+        return list(self.data.keys())
+
 
 OBJECT_TYPES = {
     "tenant": "OST_TENANT",
@@ -157,6 +193,11 @@
     "restart",
     "delete",
     "update",
+    "merged",
+    "replaced",
+    "overridden",
+    "deleted",
+    "gathered",
 )
 
 INTERFACE_FLOW_RULES_TYPES_MAPPING = {"port_channel": "PORTCHANNEL", "physical": "PHYSICAL", "l3out_sub_interface": "L3_SUBIF", "l3out_svi": "SVI"}

plugins/module_utils/endpoints/base.py

@@ -1,4 +1,5 @@
 # Copyright: (c) 2026, Allen Robel (@arobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Gaspard Micol (@gmicol) <gmicol@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
@@ -22,6 +23,7 @@
     Field,
 )
 from ansible_collections.cisco.nd.plugins.module_utils.enums import HttpVerbEnum
+from ansible_collections.cisco.nd.plugins.module_utils.types import IdentifierKey
 
 
 class NDEndpointBaseModel(BaseModel, ABC):
@@ -129,3 +131,7 @@ def verb(self) -> HttpVerbEnum:
 
         None
         """
+
+    # NOTE: function to set endpoints attribute fields from identifiers -> acts as the bridge between Models and Endpoints for API Request Orchestration
+    def set_identifiers(self, identifier: IdentifierKey = None):
+        pass

plugins/module_utils/endpoints/enums.py

@@ -0,0 +1,47 @@
+# Copyright: (c) 2026, Allen Robel (@allenrobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Gaspard Micol (@gmicol) <gmicol@cisco.com>
+
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+"""
+Enums used in endpoints.
+"""
+
+from __future__ import absolute_import, division, print_function
+
+from enum import Enum
+
+
+class VerbEnum(str, Enum):
+    """
+    # Summary
+
+    Enum for HTTP verb values used in endpoints.
+
+    ## Members
+
+    - GET: Represents the HTTP GET method.
+    - POST: Represents the HTTP POST method.
+    - PUT: Represents the HTTP PUT method.
+    - DELETE: Represents the HTTP DELETE method.
+    """
+
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    DELETE = "DELETE"
+
+
+class BooleanStringEnum(str, Enum):
+    """
+    # Summary
+
+    Enum for boolean string values used in query parameters.
+
+    ## Members
+
+    - TRUE: Represents the string "true".
+    - FALSE: Represents the string "false".
+    """
+
+    TRUE = "true"
+    FALSE = "false"

plugins/module_utils/endpoints/mixins.py

@@ -1,4 +1,5 @@
-# Copyright: (c) 2026, Allen Robel (@arobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Allen Robel (@allenrobel) <arobel@cisco.com>
+# Copyright: (c) 2026, Gaspard Micol (@gmicol) <gmicol@cisco.com>
 
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
@@ -10,7 +11,6 @@
 
 from __future__ import absolute_import, annotations, division, print_function
 
-
 from typing import Optional
 
 from ansible_collections.cisco.nd.plugins.module_utils.enums import BooleanStringEnum

plugins/module_utils/endpoints/query_params.py

@@ -11,12 +11,10 @@
 
 from __future__ import absolute_import, annotations, division, print_function
 
-
 from enum import Enum
 from typing import Optional, Protocol
 from urllib.parse import quote
 
-
 from ansible_collections.cisco.nd.plugins.module_utils.common.pydantic_compat import (
     BaseModel,
     Field,