diff --git a/products/panos/docs/panos-upgrade-assurance/api/check_firewall.md b/products/panos/docs/panos-upgrade-assurance/api/check_firewall.md index e7d2d1eea..632455a29 100644 --- a/products/panos/docs/panos-upgrade-assurance/api/check_firewall.md +++ b/products/panos/docs/panos-upgrade-assurance/api/check_firewall.md @@ -1056,3 +1056,47 @@ __Returns__ * [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) if the device is not affected, * [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) otherwise. +### `CheckFirewall.check_mp_mem_utilization` + +```python +def check_mp_mem_utilization(threshold: int = 90) -> CheckResult +``` + +Checks the current memory usage of the management plane is under the given threshold percentage. + +__Parameters__ + + +- __threshold__ (`int, optional`): (defaults to 90) Maximum acceptable memory utilization percentage. + +__Raises__ + + +- `WrongDataTypeException`: Raised when the threshold parameter is not an integer or is outside the allowed range. + +__Returns__ + + +`CheckResult`: Object of [`CheckResult`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkresult) class taking value of: + +* [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when Memory utilization is below the threshold. +* [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when Memory utilization is equal to or above the threshold. +* [`CheckStatus.ERROR`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when the data cannot be retrieved. + +### `CheckFirewall.check_config_locks` + +```python +def check_config_locks() -> CheckResult +``` + +Checks for the prescence of configuration locks on the system. A locked configuration implies an +administrator is actively working on the device. + +__Returns__ + + +`CheckResult`: Object of [`CheckResult`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkresult) class taking value of: + +* [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) if the device is not affected, +* [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) otherwise. + diff --git a/products/panos/docs/panos-upgrade-assurance/api/firewall_proxy.md b/products/panos/docs/panos-upgrade-assurance/api/firewall_proxy.md index 60f64de33..5c83c7073 100644 --- a/products/panos/docs/panos-upgrade-assurance/api/firewall_proxy.md +++ b/products/panos/docs/panos-upgrade-assurance/api/firewall_proxy.md @@ -1056,7 +1056,7 @@ __Returns__ ### `FirewallProxy.get_dp_clock` ```python -def get_dp_clock() -> dict +def get_dp_clock() -> List[datetime] ``` Get the clock information from data plane. @@ -1066,7 +1066,9 @@ The actual API command is `show clock more`. __Returns__ -`datetime`: The clock information represented as a `datetime` object. +`List[datetime]`: The clock information represented as a list of `datetime` object. + As devices can have multiple dataplanes, this function returns the time of each dataplane clock if they are + different. ### `FirewallProxy.get_certificates` @@ -1835,3 +1837,80 @@ __Returns__ } ``` +### `FirewallProxy.get_mp_mem_utilization` + +```python +def get_mp_mem_utilization() +``` + +Get management plane memory usage. + +The actual API command is `show running resource-monitor minute last {minutes}`. + +__Returns__ + + +`dict`: containing the total, used, free and cache memory details + +### `FirewallProxy.get_locks_by_type` + +```python +def get_locks_by_type(lock_type: LockType) +``` + +Helper function to make it easy to get locks by a given type + +### `FirewallProxy.get_config_locks` + +```python +def get_config_locks() -> List[dict] +``` + +Get configuration lock details from the device. + +__Returns__ + + +A list of config lock detail dictionaries + +```python showLineNumbers title="Sample output" +[ + { + '@name': 'admin', + 'type': 'shared', + 'name': 'shared', + 'created': '2026/03/19 17:00:45', + 'last-activity': '2026/03/19 17:00:45', + 'loggedin': 'yes', + 'comment': 'Testing config lock api' + } +] +``` + +### `FirewallProxy.get_commit_locks` + +```python +def get_commit_locks() -> List[dict] +``` + +Get commit lock details from the device + +__Returns__ + + +A list of config lock detail dictionaries + +```python showLineNumbers title="Sample output" +[ + { + '@name': 'admin', + 'type': 'shared', + 'name': 'shared', + 'created': '2026/03/19 17:00:45', + 'last-activity': '2026/03/19 17:00:45', + 'loggedin': 'yes', + 'comment': 'Testing config lock api' + } +] +``` +