Merge pull request #9 from dga-nagra/system_info

Started typing for system info (not all information are done)

.github/workflows/gitleaks.yml

@@ -14,6 +14,6 @@ jobs:
         with:
           fetch-depth: 0
       - uses: gitleaks/gitleaks-action@v2
-        # env:
-        #   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        #   GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }} # Only required for Organizations, not personal accounts.
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }} # Only required for Organizations, not personal accounts.

.github/workflows/python-publish.yml

@@ -8,7 +8,11 @@
 
 name: Upload Python Package
 
-on: [pull_request, workflow_dispatch]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
 
 permissions:
   contents: read

pa_api/xmlapi/client.py

@@ -936,13 +936,21 @@ def get_vpn_flows(self, name=None):
         entries = self._raw_get_vpn_flows(name=name).xpath(".//IPSec/entry")
         return [types.VPNFlow.from_xml(e) for e in entries]
 
-    def system_info(self):
+    def _raw_system_info(self):
         """
         Returns informations about the system as a XML object.
         """
         cmd = "<show><system><info></info></system></show>"
         return self.operation(cmd)
 
+    def system_info(self) -> types.operations.SystemInfo:
+        """
+        Returns informations about the system as a XML object.
+        """
+        xml = self._raw_system_info()
+        info = xml.xpath("./result/system")[0]
+        return types.operations.SystemInfo.from_xml(info)
+
     def _raw_system_resources(self):
         """
         Get the system resouces as a XML object.

pa_api/xmlapi/types/operations/__init__.py

@@ -2,3 +2,4 @@
 from .device import Device, HAInfo, VPNFlow
 from .job import Job, JobResult
 from .software import SoftwareVersion
+from .system import SystemInfo

pa_api/xmlapi/types/operations/system.py

@@ -0,0 +1,19 @@
+from pydantic import ConfigDict, Field
+
+from pa_api.xmlapi.types.utils import (
+    String,
+    XMLBaseModel,
+)
+
+
+class SystemInfo(XMLBaseModel):
+    model_config = ConfigDict(populate_by_name=True, extra="allow")
+
+    hostname: String
+    ip_address: String = Field(alias="ip-address")
+    netmask: String
+    mac_address: String = Field(alias="mac-address")
+    devicename: String
+    serial: String
+    model: String
+    sw_version: String = Field(alias="sw-version")

requirements.txt

@@ -95,9 +95,9 @@ charset-normalizer==3.3.2 ; python_version >= "3.7" and python_full_version < "4
     --hash=sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33 \
     --hash=sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519 \
     --hash=sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561
-idna==3.8 ; python_version >= "3.7" and python_full_version < "4.0.0" \
-    --hash=sha256:050b4e5baadcd44d760cedbd2b8e639f2ff89bbc7a5730fcc662954303377aac \
-    --hash=sha256:d838c2c0ed6fced7693d5e8ab8e734d5f8fda53a039c0164afb0b82e771e3603
+idna==3.10 ; python_version >= "3.7" and python_full_version < "4.0.0" \
+    --hash=sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9 \
+    --hash=sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3
 importlib-metadata==6.7.0 ; python_version == "3.7" \
     --hash=sha256:1aaf550d4f73e5d6783e7acb77aec43d49da8017410afae93822cc9cca98c4d4 \
     --hash=sha256:cb52082e659e97afc5dac71e79de97d8681de3aa07ff18578330904a9d18e5b5