acex-devkit 1.17.1__tar.gz → 2.1.0__tar.gz

{acex_devkit-1.17.1 → acex_devkit-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 1.17.1
+Version: 2.1.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.17.1 → acex_devkit-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "1.17.1"
+version = "2.1.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-2.1.0/src/acex_devkit/models/__init__.py

@@ -0,0 +1,87 @@
+"""Models for ACE-X DevKit."""
+
+from .base import PersistedResponse
+from .external_value import ExternalValue
+from .attribute_value import AttributeValue
+from .management_connection import ManagementConnection, ManagementConnectionBase, ManagementConnectionResponse, ConnectionType
+from .asset import Asset, AssetResponse, AssetClusterBase, AssetClusterCreate, AssetClusterUpdate, AssetClusterAssetResponse, AssetClusterResponse
+from .ned import Ned
+from .logical_node import LogicalNodeBase, LogicalNodeCreate, LogicalNodeListResponse, LogicalNodeResponse, LogicalNodeConfigResponse
+from .node_response import NodeResponse, NodeListItem, AssetRefType, NodeStatus
+from .credential import (
+    CredentialBase,
+    CredentialFieldBase,
+    CredentialFieldResponse,
+    CredentialResponse,
+    CredentialCreate,
+    CredentialUpdate,
+    CredentialSecret,
+    NodeCredentialCreate,
+    NodeCredentialResponse,
+)
+from .contact import ContactBase, ContactResponse
+from .site import SiteBase, SiteResponse
+from .region import RegionBase, RegionSiteInfo, RegionResponse
+from .collection_agent import (
+    CollectionAgentBase,
+    CollectionAgentMatchRuleBase,
+    CollectionAgentMatchRuleResponse,
+    CollectionAgentCreate,
+    CollectionAgentUpdate,
+    CollectionAgentResponse,
+)
+from .lldp_neighbor import LldpNeighborBase, LldpNeighborEntry, LldpNeighborUpload, LldpNeighborResponse
+from .pagination import PaginatedResponse
+
+__all__ = [
+    "PersistedResponse",
+    "ExternalValue",
+    "AttributeValue",
+    "ManagementConnection",
+    "ManagementConnectionBase",
+    "ManagementConnectionResponse",
+    "ConnectionType",
+    "Asset",
+    "AssetResponse",
+    "AssetClusterBase",
+    "AssetClusterCreate",
+    "AssetClusterUpdate",
+    "AssetClusterAssetResponse",
+    "AssetClusterResponse",
+    "Ned",
+    "LogicalNodeBase",
+    "LogicalNodeCreate",
+    "LogicalNodeListResponse",
+    "LogicalNodeResponse",
+    "LogicalNodeConfigResponse",
+    "NodeResponse",
+    "NodeListItem",
+    "AssetRefType",
+    "NodeStatus",
+    "CredentialBase",
+    "CredentialFieldBase",
+    "CredentialFieldResponse",
+    "CredentialResponse",
+    "CredentialCreate",
+    "CredentialUpdate",
+    "CredentialSecret",
+    "NodeCredentialCreate",
+    "NodeCredentialResponse",
+    "ContactBase",
+    "ContactResponse",
+    "SiteBase",
+    "SiteResponse",
+    "RegionBase",
+    "RegionSiteInfo",
+    "RegionResponse",
+    "CollectionAgentBase",
+    "CollectionAgentMatchRuleBase",
+    "CollectionAgentMatchRuleResponse",
+    "CollectionAgentCreate",
+    "CollectionAgentUpdate",
+    "CollectionAgentResponse",
+    "LldpNeighborBase",
+    "LldpNeighborEntry",
+    "LldpNeighborUpload",
+    "LldpNeighborResponse",
+]

acex_devkit-2.1.0/src/acex_devkit/models/asset.py

@@ -0,0 +1,41 @@
+from typing import Optional, Literal
+from pydantic import BaseModel, Field
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class Asset(BaseModel):
+    vendor: str = Field(default="cisco")
+    serial_number: str = Field(default="abc123")
+    os: str = Field(default="ios")
+    os_version: str = Field(default="12.0.1")
+    hardware_model: str = Field(default="")
+    ned_id: Optional[str] = None
+
+
+class AssetResponse(PersistedResponse, Asset):
+    type: Literal["asset"] = "asset"
+
+
+class AssetClusterBase(BaseModel):
+    name: str
+    ned_id: Optional[str] = None
+
+
+class AssetClusterCreate(AssetClusterBase):
+    pass
+
+
+class AssetClusterUpdate(BaseModel):
+    name: Optional[str] = None
+    ned_id: Optional[str] = None
+    asset_ids: Optional[list[int]] = None
+
+
+class AssetClusterAssetResponse(PersistedResponse, Asset):
+    cluster_index: Optional[int] = None
+
+
+class AssetClusterResponse(PersistedResponse, AssetClusterBase):
+    type: Literal["asset_cluster"] = "asset_cluster"
+    assets: list[AssetClusterAssetResponse] = []

acex_devkit-2.1.0/src/acex_devkit/models/base.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class PersistedResponse(BaseModel):
+    id: int

acex_devkit-2.1.0/src/acex_devkit/models/collection_agent.py

@@ -0,0 +1,45 @@
+from pydantic import BaseModel
+from typing import Optional
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class CollectionAgentBase(BaseModel):
+    name: str
+    description: Optional[str] = None
+    interval_seconds: int = 21600
+    enabled: bool = True
+
+
+class CollectionAgentMatchRuleBase(BaseModel):
+    region: Optional[str] = None
+    site: Optional[str] = None
+    vendor: Optional[str] = None
+    os: Optional[str] = None
+    status: Optional[str] = None
+    role: Optional[str] = None
+
+
+class CollectionAgentMatchRuleResponse(PersistedResponse, CollectionAgentMatchRuleBase):
+    pass
+
+
+class CollectionAgentCreate(CollectionAgentBase):
+    pass
+
+
+class CollectionAgentUpdate(BaseModel):
+    name: Optional[str] = None
+    description: Optional[str] = None
+    interval_seconds: Optional[int] = None
+    enabled: Optional[bool] = None
+
+
+class CollectionAgentResponse(PersistedResponse, CollectionAgentBase):
+    config_revision: int = 0
+    last_manifest_poll: Optional[str] = None
+    acked_revision: int = 0
+    acked_at: Optional[str] = None
+    nodes: list[int] = []
+    rules: list[CollectionAgentMatchRuleResponse] = []
+    resolved_nodes: list[int] = []

{acex_devkit-1.17.1 → acex_devkit-2.1.0}/src/acex_devkit/models/composed_configuration.py

@@ -706,8 +706,14 @@ class aaaAuthenticationAdminUsers(ContainerEntry, BaseModel):
     identity_fields: ClassVar[tuple[str, ...]] = ()
     config: Optional[Dict[str, adminUser]] = {}
 
+class aaaAuthenticationConfig(ContainerEntry, Augmentable):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",) 
+    name: Optional[AttributeValue[str]] = None # ex. default, CONSOLE, etc.
+    methods: Optional[Dict[str, aaaAuthenticationMethods]] = {}
+
 class aaaAuthentication(BaseModel):
-    config: Optional[Dict[str, aaaAuthenticationMethods]] = {}
+    #config: Optional[Dict[str, aaaAuthenticationMethods]] = {}
+    config: aaaAuthenticationConfig = aaaAuthenticationConfig()
     admin_user: Optional[Dict[str, aaaAuthenticationAdminUsers]] = {}
     users: Optional[Dict[str, aaaAuthenticationUsers]] = {}
 
@@ -738,10 +744,18 @@ class aaaAuthorizationEvents(aaaBaseClass):
     #event: Optional[AttributeValue[List[str]]] = None
     event: Optional[AttributeValue[str]] = None
 
-class aaaAuthorization(BaseModel):
-    config: Optional[Dict[str, aaaAuthorizationMethods]] = {}
+class aaaAuthorizationConfig(ContainerEntry, Augmentable):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",) 
+    name: Optional[AttributeValue[str]] = None # ex. default, CONSOLE, etc.
+    methods: Optional[Dict[str, aaaAuthorizationMethods]] = {}
     events: Optional[Dict[str, aaaAuthorizationEvents]] = {}
 
+class aaaAuthorization(BaseModel):
+    #config: Optional[Dict[str, aaaAuthorizationMethods]] = {}
+    config: aaaAuthorizationConfig = aaaAuthorizationConfig()
+    #methods: Optional[Dict[str, aaaAuthorizationMethods]] = {}
+    #events: Optional[Dict[str, aaaAuthorizationEvents]] = {}
+
 # Accounting Models
 class aaaAccountingMethods(ContainerEntry, BaseModel):
     identity_fields: ClassVar[tuple[str, ...]] = ()
@@ -769,11 +783,21 @@ class aaaAccountingEvents(ContainerEntry, BaseModel):
     #events: Optional[List[str]] = Field(default_factory=list) # Ex. ['send','stop-record','authentication', 'failure']
     event: Optional[AttributeValue[str]] = None
 
-class aaaAccounting(BaseModel):
-    config: Optional[Dict[str, aaaAccountingMethods]] = {}
+class aaaAccountingConfig(ContainerEntry, Augmentable):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",) 
+    name: Optional[AttributeValue[str]] = None # ex. default, CONSOLE, etc.
+    methods: Optional[Dict[str, aaaAccountingMethods]] = {}
     events: Optional[Dict[str, aaaAccountingEvents]] = {}
 
-class aaaGlobalAttributes(BaseModel):
+class aaaAccounting(BaseModel):
+    #config: Optional[Dict[str, aaaAccountingMethods]] = {}
+    config: aaaAccountingConfig = aaaAccountingConfig()
+    #methods: Optional[Dict[str, aaaAccountingMethods]] = {}
+    #events: Optional[Dict[str, aaaAccountingEvents]] = {}
+
+class aaaGlobalAttributes(ContainerEntry, BaseModel):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",) 
+    name: Optional[AttributeValue[str]] = None # ex. default, CONSOLE, etc.
     enabled: Optional[AttributeValue[bool]] = False # default False
 
 class TripleA(BaseModel):

acex_devkit-2.1.0/src/acex_devkit/models/contact.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class ContactBase(BaseModel):
+    name: str = Field(default="")
+    display_name: Optional[str] = None
+    first_name: Optional[str] = None
+    family_name: Optional[str] = None
+    email: Optional[str] = None
+    phone: Optional[str] = None
+    role: Optional[str] = None
+
+
+class ContactResponse(PersistedResponse, ContactBase):
+    pass

acex_devkit-2.1.0/src/acex_devkit/models/credential.py

@@ -0,0 +1,52 @@
+from pydantic import BaseModel
+from typing import Optional, Dict, List
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class CredentialFieldBase(BaseModel):
+    field_name: str
+    sensitive: bool = True
+
+
+class CredentialBase(BaseModel):
+    name: str
+    credential_type: str
+    source: str = "local"
+    vault_path: Optional[str] = None
+
+
+class CredentialFieldResponse(CredentialFieldBase):
+    field_value: Optional[str] = None
+
+
+class CredentialResponse(PersistedResponse, CredentialBase):
+    fields: List[CredentialFieldResponse] = []
+
+
+class CredentialCreate(CredentialBase):
+    fields: Dict[str, str]
+
+
+class CredentialUpdate(BaseModel):
+    name: Optional[str] = None
+    source: Optional[str] = None
+    vault_path: Optional[str] = None
+    fields: Optional[Dict[str, str]] = None
+
+
+class CredentialSecret(BaseModel):
+    id: int
+    credential_type: str
+    fields: Dict[str, str] = {}
+
+
+class NodeCredentialCreate(BaseModel):
+    credential_id: int
+
+
+class NodeCredentialResponse(PersistedResponse):
+    node_id: int
+    credential_id: int
+    credential_name: Optional[str] = None
+    credential_type: Optional[str] = None

acex_devkit-2.1.0/src/acex_devkit/models/lldp_neighbor.py

@@ -0,0 +1,27 @@
+from pydantic import BaseModel
+from typing import Optional
+from datetime import datetime
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class LldpNeighborBase(BaseModel):
+    local_interface: str
+    remote_device: str
+    remote_interface: str = ""
+    discovery_protocol: str = "lldp"
+
+
+class LldpNeighborEntry(LldpNeighborBase):
+    pass
+
+
+class LldpNeighborUpload(BaseModel):
+    node_instance_id: int
+    neighbors: list[LldpNeighborEntry]
+
+
+class LldpNeighborResponse(PersistedResponse, LldpNeighborBase):
+    node_instance_id: int
+    remote_node_id: Optional[int] = None
+    collected_at: datetime

{acex_devkit-1.17.1 → acex_devkit-2.1.0}/src/acex_devkit/models/logging.py

@@ -42,7 +42,8 @@ class LoggingConfig(Augmentable):
     severity: Optional[AttributeValue[LoggingSeverity]] = None
     buffer_size: Optional[AttributeValue[int]] = None
 
-class Console(Augmentable):
+class Console(ContainerEntry, Augmentable):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
     name: Optional[AttributeValue[str]] = None
     line_number: Optional[AttributeValue[int]] = None
     logging_synchronous: Optional[AttributeValue[bool]] = None
@@ -58,7 +59,7 @@ class RemoteServer(ContainerEntry, BaseModel):
 class RemoteServers(BaseModel):
     servers: Dict[str, RemoteServer] = {}
 
-class VtyLine(ContainerEntry, BaseModel):
+class VtyLine(ContainerEntry, Augmentable):
     identity_fields: ClassVar[tuple[str, ...]] = ("line_number",)
     name: Optional[AttributeValue[str]] = None
     line_number: Optional[AttributeValue[int]] = None

acex_devkit-2.1.0/src/acex_devkit/models/logical_node.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel, Field
+from typing import Optional, Dict, Any
+
+from acex_devkit.models.base import PersistedResponse
+from acex_devkit.models.composed_configuration import ComposedConfiguration
+
+
+class LogicalNodeBase(BaseModel):
+    hostname: str = Field(default="R1")
+    role: str = Field(default="core")
+    site: Optional[str] = Field(default=None)
+    sequence: Optional[int] = Field(default=None)
+
+
+class LogicalNodeCreate(LogicalNodeBase):
+    pass
+
+
+class LogicalNodeListResponse(PersistedResponse, LogicalNodeBase):
+    regions: list[str] = []
+
+
+class LogicalNodeResponse(PersistedResponse, LogicalNodeBase):
+    regions: list[str] = []
+
+
+class LogicalNodeConfigResponse(PersistedResponse, LogicalNodeBase):
+    configuration: ComposedConfiguration
+    meta_data: Dict[str, Any] = {}
+    regions: list[str] = []

acex_devkit-2.1.0/src/acex_devkit/models/management_connection.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel
+from typing import Optional
+from enum import Enum
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class ConnectionType(str, Enum):
+    ssh = "ssh"
+    telnet = "telnet"
+
+
+class ManagementConnectionBase(BaseModel):
+    primary: bool = True
+    connection_type: ConnectionType = ConnectionType.ssh
+    target_ip: Optional[str] = None
+
+
+class ManagementConnectionResponse(PersistedResponse, ManagementConnectionBase):
+    node_id: int
+
+
+# Kept for backward compatibility
+ManagementConnection = ManagementConnectionResponse

acex_devkit-2.1.0/src/acex_devkit/models/node_response.py

@@ -0,0 +1,57 @@
+from pydantic import BaseModel, Field
+from typing import Annotated, Optional, Union
+from enum import Enum
+from datetime import datetime
+
+from acex_devkit.models.base import PersistedResponse
+from acex_devkit.models.logical_node import LogicalNodeResponse
+from acex_devkit.models.asset import Asset, AssetClusterBase, AssetClusterAssetResponse, AssetResponse, AssetClusterResponse
+
+
+class AssetRefType(str, Enum):
+    asset = "asset"
+    asset_cluster = "asset_cluster"
+
+
+class NodeStatus(str, Enum):
+    planned = "planned"
+    init = "init"
+    active = "active"
+    decommissioned = "decommissioned"
+
+
+class NodeBase(BaseModel):
+    asset_ref_id: int
+    asset_ref_type: Optional[AssetRefType] = None
+    logical_node_id: int
+    status: Optional[NodeStatus] = None
+
+
+class NodeListItem(PersistedResponse, NodeBase):
+    hostname: Optional[str] = None
+    site: Optional[str] = None
+    role: Optional[str] = None
+    regions: list[str] = []
+    vendor: Optional[str] = None
+    os: Optional[str] = None
+    ned_id: Optional[str] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class NodeResponse(PersistedResponse, NodeBase):
+    asset: Annotated[Union[AssetResponse, AssetClusterResponse], Field(discriminator="type")]
+    logical_node: LogicalNodeResponse
+    regions: list[str] = []
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+
+__all__ = [
+    "LogicalNodeResponse",
+    "AssetRefType",
+    "NodeStatus",
+    "NodeBase",
+    "NodeListItem",
+    "NodeResponse",
+]

acex_devkit-2.1.0/src/acex_devkit/models/pagination.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+from typing import Generic, TypeVar, List
+
+T = TypeVar("T")
+
+
+class PaginatedResponse(BaseModel, Generic[T]):
+    items: List[T]
+    total: int
+    limit: int
+    offset: int

acex_devkit-2.1.0/src/acex_devkit/models/region.py

@@ -0,0 +1,23 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+
+from acex_devkit.models.base import PersistedResponse
+
+
+class RegionBase(BaseModel):
+    name: str = Field(default="")
+    display_name: Optional[str] = None
+    description: Optional[str] = None
+
+
+class RegionSiteInfo(BaseModel):
+    name: str
+    display_name: Optional[str] = None
+    city: Optional[str] = None
+    country: Optional[str] = None
+    latitude: Optional[float] = None
+    longitude: Optional[float] = None
+
+
+class RegionResponse(PersistedResponse, RegionBase):
+    sites: list[RegionSiteInfo] = []

acex_devkit-2.1.0/src/acex_devkit/models/site.py

@@ -0,0 +1,20 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+
+from acex_devkit.models.base import PersistedResponse
+from acex_devkit.models.contact import ContactResponse
+
+
+class SiteBase(BaseModel):
+    name: str = Field(default="")
+    display_name: Optional[str] = None
+    address: Optional[str] = None
+    city: Optional[str] = None
+    country: Optional[str] = None
+    latitude: Optional[float] = None
+    longitude: Optional[float] = None
+    description: Optional[str] = None
+
+
+class SiteResponse(PersistedResponse, SiteBase):
+    contacts: list[ContactResponse] = []

acex_devkit-1.17.1/src/acex_devkit/models/__init__.py

@@ -1,17 +0,0 @@
-"""Models for ACE-X DevKit."""
-
-# TODO: Move all models to this package
-# TODO: Move all base classes to this package
-
-from .external_value import ExternalValue
-from .attribute_value import AttributeValue
-from .node_response import NodeResponse, NodeListItem, LogicalNodeResponse
-from .management_connection import ManagementConnection, ConnectionType
-
-__all__ = [
-    ExternalValue,
-    AttributeValue,
-    NodeResponse,
-    NodeListItem,
-    LogicalNodeResponse
-    ]

acex_devkit-1.17.1/src/acex_devkit/models/management_connection.py

@@ -1,16 +0,0 @@
-from pydantic import BaseModel
-from typing import Optional
-from enum import Enum
-
-
-class ConnectionType(str, Enum):
-    ssh = "ssh"
-    telnet = "telnet"
-
-
-class ManagementConnection(BaseModel):
-    id: Optional[int] = None
-    node_id: Optional[int] = None
-    primary: bool = True
-    connection_type: ConnectionType = ConnectionType.ssh
-    target_ip: Optional[str] = None

acex_devkit-1.17.1/src/acex_devkit/models/node_response.py

@@ -1,91 +0,0 @@
-from pydantic import BaseModel, Field
-from typing import Annotated, Optional, Dict, Any, List, Literal, Union
-from enum import Enum
-from datetime import datetime
-from acex_devkit.models.composed_configuration import ComposedConfiguration
-
-
-class LogicalNodeResponse(BaseModel):
-    id: Optional[int] = None
-    hostname: Optional[str] = None
-    role: Optional[str] = None
-    site: Optional[str] = None
-    sequence: Optional[int] = None
-    configuration: Optional[ComposedConfiguration] = None
-    meta_data: Optional[Dict[str, Any]] = None
-
-
-class Asset(BaseModel):
-    id: Optional[int] = None
-    type: Literal["asset"] = "asset"
-    vendor: Optional[str] = None
-    serial_number: Optional[str] = None
-    os: Optional[str] = None
-    os_version: Optional[str] = None
-    hardware_model: Optional[str] = None
-    ned_id: Optional[str] = None
-
-
-class AssetClusterAsset(BaseModel):
-    id: Optional[int] = None
-    vendor: Optional[str] = None
-    serial_number: Optional[str] = None
-    os: Optional[str] = None
-    os_version: Optional[str] = None
-    hardware_model: Optional[str] = None
-    ned_id: Optional[str] = None
-    cluster_index: Optional[int] = None
-
-
-class AssetCluster(BaseModel):
-    id: Optional[int] = None
-    type: Literal["asset_cluster"] = "asset_cluster"
-    name: Optional[str] = None
-    ned_id: Optional[str] = None
-    assets: List[AssetClusterAsset] = []
-
-
-class AssetRefType(str, Enum):
-    asset = "asset"
-    asset_cluster = "asset_cluster"
-
-
-class NodeStatus(str, Enum):
-    planned = "planned"
-    init = "init"
-    active = "active"
-    decommissioned = "decommissioned"
-
-
-class NodeBase(BaseModel):
-    asset_ref_id: int
-    asset_ref_type: Optional[AssetRefType] = None
-    logical_node_id: int
-    status: Optional[NodeStatus] = None
-
-class Node(NodeBase):
-    id: Optional[int] = None
-    created_at: Optional[datetime] = None
-    updated_at: Optional[datetime] = None
-
-
-class NodeListItem(NodeBase):
-    """Enriched list representation with denormalized fields from asset and logical_node."""
-    id: Optional[int] = None
-    # From logical_node
-    hostname: Optional[str] = None
-    site: Optional[str] = None
-    # From asset
-    vendor: Optional[str] = None
-    os: Optional[str] = None
-    ned_id: Optional[str] = None
-    created_at: Optional[datetime] = None
-    updated_at: Optional[datetime] = None
-
-
-class NodeResponse(NodeBase):
-    id: Optional[int] = None
-    asset: Annotated[Union[Asset, AssetCluster], Field(discriminator="type")]
-    logical_node: LogicalNodeResponse
-    created_at: datetime
-    updated_at: Optional[datetime] = None