python-netgear-switch-library 0.0.post340__tar.gz → 0.0.post342__tar.gz

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-netgear-switch-library
-Version: 0.0.post340
+Version: 0.0.post342
 Summary: Python library and CLI to query and control Netgear switches over SNMP, NSDP and HTTP.
 Author-email: Tim Ansell <me@mith.ro>
 License-Expression: Apache-2.0

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/src/netgear_switch/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.0.post340'
-__version_tuple__ = version_tuple = (0, 0, 'post340')
+__version__ = version = '0.0.post342'
+__version_tuple__ = version_tuple = (0, 0, 'post342')
 
 __commit_id__ = commit_id = None

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/src/netgear_switch/aio_api.py

@@ -95,6 +95,7 @@ if TYPE_CHECKING:
         PortStats,
         PortStatus,
         Sensor,
+        SyslogConfig,
         VLANInfo,
         VlanMode,
     )
@@ -447,6 +448,10 @@ class AsyncSwitch:
     async def get_mgmt_ip(self, *, backend: Backend | None = None) -> MgmtIpConfig:
         return await self._read(lambda r: r.get_mgmt_ip(), backend)
 
+    async def get_syslog(self, *, backend: Backend | None = None) -> SyslogConfig:
+        """Async twin of ``SyncSwitch.get_syslog`` -- see there."""
+        return await self._read(lambda r: r.get_syslog(), backend)
+
     async def get_hostname(self, *, backend: Backend | None = None) -> str:
         """Async twin of ``SyncSwitch.get_hostname`` -- see there."""
         return await self._read(lambda r: r.get_hostname(), backend)
@@ -640,6 +645,16 @@ class AsyncSwitch:
             lambda w: w.clear_poe_fault(port, force=force, timeouts=timeouts), backend
         )
 
+    async def set_hostname(
+        self, name: str, *, force: bool = False, backend: Backend | None = None
+    ) -> None:
+        """Async twin of ``SyncSwitch.set_hostname`` -- see there.
+
+        Note AsyncSwitch has no CLI backend at all, so on this facade the write
+        resolves over SNMP or not at all.
+        """
+        await self._write(lambda w: w.set_hostname(name, force=force), backend)
+
     async def set_mgmt_ip(
         self,
         address: str,

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/src/netgear_switch/capabilities.py

@@ -114,6 +114,19 @@ READ_OPERATIONS: tuple[Operation, ...] = (
     Operation("get_sensors", OperationKind.READ, "Fan/PSU/temperature sensors"),
     Operation("get_mgmt_ip", OperationKind.READ, "Management IP configuration"),
     Operation("get_hostname", OperationKind.READ, "The switch's host name"),
+    Operation(
+        "get_syslog",
+        OperationKind.READ,
+        "Remote-logging configuration and collectors",
+        # SNMP and the CLI are the two backends that READ this today, and the
+        # two agree field-for-field on live hardware. Restricting the op here
+        # states what the LIBRARY serves; it deliberately does NOT assert that
+        # a web UI cannot show syslog. No dialect's syslog page has been
+        # located or captured yet, so HTTP is an unbuilt implementation -- a
+        # bug to fix, in this project's terms, not a device limitation. NSDP
+        # has no logging tag in the exhaustive tag sweep of a live GS110EMX.
+        backends=frozenset({Backend.SNMP}) | _CLI_BACKENDS,
+    ),
     Operation(
         "nsdp_device",
         OperationKind.READ,
@@ -136,6 +149,21 @@ WRITE_OPERATIONS: tuple[Operation, ...] = (
     Operation("create_vlan", OperationKind.WRITE, "Create a VLAN"),
     Operation("delete_vlan", OperationKind.WRITE, "Delete a VLAN"),
     Operation("set_mgmt_ip", OperationKind.WRITE, "Set the management IP/mask/gateway"),
+    Operation(
+        "set_hostname",
+        OperationKind.WRITE,
+        "Set the switch's host name",
+        # SNMP (sysName, confirmed writable on all five reachable switches) and
+        # the FASTPATH CLI (`hostname`) are what the library writes today.
+        #
+        # This restriction makes a REAL GAP visible rather than hiding it: the
+        # Plus models have neither backend, so this library currently cannot
+        # rename a gs110emx, gs105pe or gs305ep at all. Both routes exist on the
+        # devices -- NSDP carries a writable HOSTNAME tag and two web UIs expose
+        # a switch_name field -- so this is unbuilt work, not a device limit,
+        # and the support table should show the hole until it is filled.
+        backends=frozenset({Backend.SNMP}) | _CLI_BACKENDS,
+    ),
     Operation(
         "upload_certificate",
         OperationKind.WRITE,
@@ -213,6 +241,17 @@ def _snmp_support(model: SwitchModel, op: Operation) -> tuple[Support, str]:
             f"model {model.key!r} registers no Netgear vendor OID subtree, and "
             "the management-IP write columns are vendor-only",
         )
+    if op.name == "get_syslog" and not oids.has_vendor_oids(model):
+        # Logging lives at <vendor base>.14 on both vendor families, so a model
+        # whose agent registers no 4526 subtree at all (gs728tpp -- a walk of
+        # 1.3.6.1.4.1.4526 answers noSuchObject) has nothing to read.
+        # SnmpReader.get_syslog refuses by name for the same reason: an empty
+        # result would be indistinguishable from a switch with no collectors.
+        return (
+            Support.UNSUPPORTED,
+            f"model {model.key!r} registers no Netgear vendor OID subtree, and "
+            "the logging columns are vendor-only",
+        )
     if op.name == "get_macs" and not model.has_mac_table:  # pragma: no cover
         # Unreachable today: has_mac_table IS "has an SNMP backend". Kept so the
         # rule tracks the property rather than assuming its current definition.

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/src/netgear_switch/sync_api.py

@@ -157,6 +157,7 @@ if TYPE_CHECKING:
         PortStats,
         PortStatus,
         Sensor,
+        SyslogConfig,
         VLANInfo,
         VlanMode,
     )
@@ -552,6 +553,17 @@ class SyncSwitch:
     def get_mgmt_ip(self, *, backend: Backend | None = None) -> MgmtIpConfig:
         return self._read(lambda r: r.get_mgmt_ip(), backend)
 
+    def get_syslog(self, *, backend: Backend | None = None) -> SyslogConfig:
+        """Remote-logging configuration: whether it is on, and its collectors.
+
+        Served over SNMP and the FASTPATH CLI, which agree field-for-field on
+        live hardware. ``gs728tpp`` is refused over SNMP by name: it registers
+        no Netgear vendor subtree, and the logging columns are vendor-only, so
+        an empty result would be indistinguishable from a switch with no
+        collectors configured.
+        """
+        return self._read(lambda r: r.get_syslog(), backend)
+
     def get_hostname(self, *, backend: Backend | None = None) -> str:
         """The switch's host name.
 
@@ -783,6 +795,21 @@ class SyncSwitch:
             lambda w: w.clear_poe_fault(port, force=force, timeouts=timeouts), backend
         )
 
+    def set_hostname(
+        self, name: str, *, force: bool = False, backend: Backend | None = None
+    ) -> None:
+        """Set the switch's host name, and read it back to confirm.
+
+        Written over SNMP (``sysName``) or the FASTPATH CLI (``hostname``),
+        whichever backend resolves. Not force-gated: renaming cannot strand a
+        switch and is reversible by writing the old name back, unlike
+        ``set_mgmt_ip``, which drops the session that issues it.
+
+        The Plus models cannot be renamed by this library yet -- they have
+        neither backend, and the NSDP and web-UI routes are unbuilt.
+        """
+        self._write(lambda w: w.set_hostname(name, force=force), backend)
+
     def set_mgmt_ip(
         self,
         address: str,

{python_netgear_switch_library-0.0.post340 → python_netgear_switch_library-0.0.post342}/tests/test_capabilities.py

@@ -93,6 +93,10 @@ _WRITE_ARGS: dict[str, tuple[tuple[Any, ...], dict[str, Any]]] = {
     "create_vlan": ((4008, "capcheck"), {}),
     "delete_vlan": ((4008,), {}),
     "set_mgmt_ip": (("10.99.0.2", "255.255.255.0", "10.99.0.1"), {}),
+    # A non-empty name: set_hostname refuses an empty one outright, because
+    # `hostname` with no argument is rejected by the device itself and clearing
+    # a name is a different command (`no hostname`) that is not implemented.
+    "set_hostname": (("capcheck",), {}),
 }
 
 #: Not driven. ``upload_certificate_scp`` runs a multi-command deploy sequence