PyPI - python-netgear-switch-library - Versions diffs - 0.0.post337__tar.gz → 0.0.post339__tar.gz - Mend

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-netgear-switch-library
-Version: 0.0.post337
+Version: 0.0.post339
 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

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

@@ -447,6 +447,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_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)
     async def nsdp_device(self) -> NsdpDevice:
         """Async twin of ``SyncSwitch.nsdp_device`` -- see there."""
         reader = self._reader_for(Backend.NSDP)

@@ -113,6 +113,7 @@ READ_OPERATIONS: tuple[Operation, ...] = (
     Operation("get_poe", OperationKind.READ, "Per-port PoE status and power draw"),
     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(
         "nsdp_device",
         OperationKind.READ,
@@ -247,7 +248,7 @@ def _http_path_for(spec: HttpModelSpec, op: Operation) -> str | None:
     ops with composite conditions defer to the reader's own helpers so there is
     exactly one definition of "this UI can answer that".
     """
-    from .http_read import _mgmt_ip_path, _supports_sensors
+    from .http_read import _has_sysinfo_hostname, _mgmt_ip_path, _supports_sensors
     simple: dict[str, str | None] = {
         "get_ports": spec.dashboard_path,
@@ -269,6 +270,11 @@ def _http_path_for(spec: HttpModelSpec, op: Operation) -> str | None:
     }
     if op.name == "get_sensors":
         return spec.sysinfo_path if _supports_sensors(spec) else None
+    if op.name == "get_hostname":
+        # Only two identity pages carry the field (gs110emx's sysInfo.html and
+        # gs105pe's switch_info.cgi); the reader's own predicate decides, so
+        # there is one definition rather than two that can drift.
+        return spec.sysinfo_path if _has_sysinfo_hostname(spec) else None
     if op.name == "get_mgmt_ip":
         return _mgmt_ip_path(spec)
     if op.name == "set_mgmt_ip":

@@ -380,6 +380,20 @@ def _with_fastpath_egress(
     return out
+def _has_sysinfo_hostname(spec: HttpModelSpec) -> bool:
+    """Whether this dialect's identity page carries the switch's host name.
+    True only for the two whose parsers extract it -- gs110emx's
+    ``sysInfo.html`` (``switch_name`` input) and gs105pe's ``switch_info.cgi``.
+    The FASTPATH/XE, M4300 and GoAhead identity pages were checked and carry no
+    host-name field, so their models read the name over SNMP or the CLI, both of
+    which they have.
+    """
+    return spec.sysinfo_path is not None and (
+        _is_gs110emx_dialect(spec) or _is_gs105pe_dialect(spec)
+    )
 def _parse_sysinfo(spec: HttpModelSpec, html: str) -> HttpSysInfo:
     """Dispatch the device-identity/mgmt-IP page: gs105pe's switch_info.cgi
     (lowercase ip_address inputs, dhcpMode select) vs gs110emx's sysInfo.html."""
@@ -629,6 +643,25 @@ class HttpReader:
             self._spec, self.session.get_page(self._spec.sysinfo_path)
         )
+    def get_hostname(self) -> str:
+        """The switch's host name, from its device-identity page.
+        Only the two dialects whose identity page actually carries the field can
+        serve this: gs110emx's ``sysInfo.html`` and gs105pe's
+        ``switch_info.cgi``, both of which already expose it as
+        ``HttpSysInfo.switch_name``. Every other dialect's identity page has no
+        such field, and is refused by name rather than returning "" -- an empty
+        string is a real host name on a switch that has never been named, so it
+        must not double as "this backend cannot tell you".
+        """
+        if not _has_sysinfo_hostname(self._spec):
+            raise _unsupported(self.model.key, "a host name field")
+        assert self._spec.sysinfo_path is not None  # guaranteed by the guard
+        info = _parse_sysinfo(
+            self._spec, self.session.get_page(self._spec.sysinfo_path)
+        )
+        return info.switch_name
     def get_mgmt_ip(self) -> MgmtIpConfig:
         path = _mgmt_ip_path(self._spec)
         if path is None:

@@ -552,6 +552,20 @@ class SyncSwitch:
     def get_mgmt_ip(self, *, backend: Backend | None = None) -> MgmtIpConfig:
         return self._read(lambda r: r.get_mgmt_ip(), backend)
+    def get_hostname(self, *, backend: Backend | None = None) -> str:
+        """The switch's host name.
+        Every backend can answer, but from a different place: SNMP reads the
+        standard ``sysName`` scalar, NSDP the ``HOSTNAME`` tag, the CLI
+        ``show hosts``, and the web UI the device-identity page -- on the two
+        dialects whose page carries the field; the rest refuse by name.
+        The CLI deliberately parses ``show hosts`` rather than
+        ``show running-config``: the two report different values on real
+        hardware, and only ``show hosts`` agrees with ``sysName``.
+        """
+        return self._read(lambda r: r.get_hostname(), backend)
     def nsdp_device(self) -> NsdpDevice:
         """Return the COMPLETE raw ``NsdpDevice`` for this switch: model, MAC,
         hostname, mgmt IP, firmware, DHCP mode, port count, serial number,

python-netgear-switch-library 0.0.post337__tar.gz → 0.0.post339__tar.gz

python-netgear-switch-library 0.0.post337tar.gz → 0.0.post339tar.gz