Skip to content

Commit f81fa65

Browse files
docs: PanOS Upgrade Assurance documentation update
1 parent d89be3e commit f81fa65

2 files changed

Lines changed: 125 additions & 2 deletions

File tree

products/panos/docs/panos-upgrade-assurance/api/check_firewall.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,3 +1056,47 @@ __Returns__
10561056
* [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) if the device is not affected,
10571057
* [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) otherwise.
10581058

1059+
### `CheckFirewall.check_mp_mem_utilization`
1060+
1061+
```python
1062+
def check_mp_mem_utilization(threshold: int = 90) -> CheckResult
1063+
```
1064+
1065+
Checks the current memory usage of the management plane is under the given threshold percentage.
1066+
1067+
__Parameters__
1068+
1069+
1070+
- __threshold__ (`int, optional`): (defaults to 90) Maximum acceptable memory utilization percentage.
1071+
1072+
__Raises__
1073+
1074+
1075+
- `WrongDataTypeException`: Raised when the threshold parameter is not an integer or is outside the allowed range.
1076+
1077+
__Returns__
1078+
1079+
1080+
`CheckResult`: Object of [`CheckResult`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkresult) class taking value of:
1081+
1082+
* [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when Memory utilization is below the threshold.
1083+
* [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when Memory utilization is equal to or above the threshold.
1084+
* [`CheckStatus.ERROR`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) when the data cannot be retrieved.
1085+
1086+
### `CheckFirewall.check_config_locks`
1087+
1088+
```python
1089+
def check_config_locks() -> CheckResult
1090+
```
1091+
1092+
Checks for the prescence of configuration locks on the system. A locked configuration implies an
1093+
administrator is actively working on the device.
1094+
1095+
__Returns__
1096+
1097+
1098+
`CheckResult`: Object of [`CheckResult`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkresult) class taking value of:
1099+
1100+
* [`CheckStatus.SUCCESS`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) if the device is not affected,
1101+
* [`CheckStatus.FAIL`](/panos/docs/panos-upgrade-assurance/api/utils#class-checkstatus) otherwise.
1102+

products/panos/docs/panos-upgrade-assurance/api/firewall_proxy.md

Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,7 +1056,7 @@ __Returns__
10561056
### `FirewallProxy.get_dp_clock`
10571057

10581058
```python
1059-
def get_dp_clock() -> dict
1059+
def get_dp_clock() -> List[datetime]
10601060
```
10611061

10621062
Get the clock information from data plane.
@@ -1066,7 +1066,9 @@ The actual API command is `show clock more`.
10661066
__Returns__
10671067

10681068

1069-
`datetime`: The clock information represented as a `datetime` object.
1069+
`List[datetime]`: The clock information represented as a list of `datetime` object.
1070+
As devices can have multiple dataplanes, this function returns the time of each dataplane clock if they are
1071+
different.
10701072

10711073
### `FirewallProxy.get_certificates`
10721074

@@ -1835,3 +1837,80 @@ __Returns__
18351837
}
18361838
```
18371839

1840+
### `FirewallProxy.get_mp_mem_utilization`
1841+
1842+
```python
1843+
def get_mp_mem_utilization()
1844+
```
1845+
1846+
Get management plane memory usage.
1847+
1848+
The actual API command is `show running resource-monitor minute last {minutes}`.
1849+
1850+
__Returns__
1851+
1852+
1853+
`dict`: containing the total, used, free and cache memory details
1854+
1855+
### `FirewallProxy.get_locks_by_type`
1856+
1857+
```python
1858+
def get_locks_by_type(lock_type: LockType)
1859+
```
1860+
1861+
Helper function to make it easy to get locks by a given type
1862+
1863+
### `FirewallProxy.get_config_locks`
1864+
1865+
```python
1866+
def get_config_locks() -> List[dict]
1867+
```
1868+
1869+
Get configuration lock details from the device.
1870+
1871+
__Returns__
1872+
1873+
1874+
A list of config lock detail dictionaries
1875+
1876+
```python showLineNumbers title="Sample output"
1877+
[
1878+
{
1879+
'@name': 'admin',
1880+
'type': 'shared',
1881+
'name': 'shared',
1882+
'created': '2026/03/19 17:00:45',
1883+
'last-activity': '2026/03/19 17:00:45',
1884+
'loggedin': 'yes',
1885+
'comment': 'Testing config lock api'
1886+
}
1887+
]
1888+
```
1889+
1890+
### `FirewallProxy.get_commit_locks`
1891+
1892+
```python
1893+
def get_commit_locks() -> List[dict]
1894+
```
1895+
1896+
Get commit lock details from the device
1897+
1898+
__Returns__
1899+
1900+
1901+
A list of config lock detail dictionaries
1902+
1903+
```python showLineNumbers title="Sample output"
1904+
[
1905+
{
1906+
'@name': 'admin',
1907+
'type': 'shared',
1908+
'name': 'shared',
1909+
'created': '2026/03/19 17:00:45',
1910+
'last-activity': '2026/03/19 17:00:45',
1911+
'loggedin': 'yes',
1912+
'comment': 'Testing config lock api'
1913+
}
1914+
]
1915+
```
1916+

0 commit comments

Comments
 (0)