Ansible ND 4.X | Resource Manager Module with Pydantic Models + Smart Endpoints

plugins/module_utils/common/log.py

@@ -417,7 +417,7 @@ def develop(self, value: bool) -> None:
         logging.raiseExceptions = value
 
 
-def setup_logging(module: "AnsibleModule", develop: bool = False) -> Log:
+def setup_logging(module: "AnsibleModule", develop: bool = False, config: Optional[str] = None) -> Log:
     """
     # Summary
 
@@ -434,6 +434,9 @@ def setup_logging(module: "AnsibleModule", develop: bool = False) -> Log:
 
     -   Calls `module.fail_json()` if logging configuration fails, which
         exits the module with an error message rather than raising an exception.
+    -   If `config` is provided it overrides the `ND_LOGGING_CONFIG` environment
+        variable.  Pass `None` (the default) to rely solely on the environment
+        variable.
 
     ## Usage
 
@@ -445,6 +448,12 @@ def main():
         log = setup_logging(module)
     ```
 
+    To point at a specific config file (e.g. during local development):
+
+    ```python
+    log = setup_logging(module, config="/path/to/logging_config.json")
+    ```
+
     To enable logging exceptions during development, pass `develop=True`:
 
     ```python
@@ -453,6 +462,8 @@ def main():
     """
     try:
         log = Log(develop=develop)
+        if config is not None:
+            log.config = config
         log.commit()
     except ValueError as error:
         module.fail_json(msg=str(error))

plugins/module_utils/endpoints/mixins.py

@@ -32,6 +32,12 @@ class FabricNameMixin(BaseModel):
     fabric_name: Optional[str] = Field(default=None, min_length=1, max_length=64, description="Fabric name")
 
 
+class FilterMixin(BaseModel):
+    """Mixin for endpoints that require a Lucene filter expression."""
+
+    filter: Optional[str] = Field(default=None, min_length=1, description="Lucene filter expression")
+
+
 class ForceShowRunMixin(BaseModel):
     """Mixin for endpoints that require force_show_run parameter."""
 
@@ -68,16 +74,28 @@ class LoginIdMixin(BaseModel):
     login_id: Optional[str] = Field(default=None, min_length=1, description="Login ID")
 
 
+class MaxMixin(BaseModel):
+    """Mixin for endpoints that require a max results parameter."""
+
+    max: Optional[int] = Field(default=None, ge=1, description="Maximum number of results")
+
+
 class NetworkNameMixin(BaseModel):
     """Mixin for endpoints that require network_name parameter."""
 
     network_name: Optional[str] = Field(default=None, min_length=1, max_length=64, description="Network name")
 
 
-class NodeNameMixin(BaseModel):
-    """Mixin for endpoints that require node_name parameter."""
+class OffsetMixin(BaseModel):
+    """Mixin for endpoints that require a pagination offset parameter."""
 
-    node_name: Optional[str] = Field(default=None, min_length=1, description="Node name")
+    offset: Optional[int] = Field(default=None, ge=0, description="Pagination offset")
+
+
+class SwitchIdMixin(BaseModel):
+    """Mixin for endpoints that require switch_id parameter."""
+
+    switch_id: Optional[str] = Field(default=None, min_length=1, description="Switch serial number or ID")
 
 
 class SwitchSerialNumberMixin(BaseModel):
@@ -86,7 +104,25 @@ class SwitchSerialNumberMixin(BaseModel):
     switch_sn: Optional[str] = Field(default=None, min_length=1, description="Switch serial number")
 
 
+class TenantNameMixin(BaseModel):
+    """Mixin for endpoints that require tenant_name parameter."""
+
+    tenant_name: Optional[str] = Field(default=None, min_length=1, description="Tenant name")
+
+
+class TicketIdMixin(BaseModel):
+    """Mixin for endpoints that require ticket_id parameter."""
+
+    ticket_id: Optional[str] = Field(default=None, min_length=1, description="Change control ticket ID")
+
+
 class VrfNameMixin(BaseModel):
     """Mixin for endpoints that require vrf_name parameter."""
 
     vrf_name: Optional[str] = Field(default=None, min_length=1, max_length=64, description="VRF name")
+
+
+class NodeNameMixin(BaseModel):
+    """Mixin for endpoints that require node_name parameter."""
+
+    node_name: Optional[str] = Field(default=None, min_length=1, description="Node name")