christianmanivong
c9a7ee4378
driver / standard (pull_request) Successful in 13s
driver / lint (pull_request) Successful in 12s
driver / types (pull_request) Successful in 43s
driver / test (3.10) (pull_request) Successful in 46s
driver / test (3.11) (pull_request) Successful in 48s
driver / test (3.12) (pull_request) Successful in 43s
driver / test (3.13) (pull_request) Successful in 39s
driver / lowest (pull_request) Successful in 23s
driver / security (pull_request) Successful in 46s
driver / build (pull_request) Successful in 22s
CI / driver (pull_request) Successful in 5m37s
driver / publish (pull_request) Skipped
- CI arrives in .gitea/workflows/ci.yml and calls the shared driver workflow of NAPALM/driver-standard; the repo had none before. - setuptools>=77 and the SPDX license string PEP 639 wants, without the License classifier; napalm-device-types>=4.21.1 from PyPI; Issues and Changelog links on git.netork.io. LICENSE, NOTICE and py.typed were already there and stay. - The test extra becomes the dev extra of the standard, plus responses, which the tests mock AMT with. - mypy strict with the untyped imports (napalm, requests, defusedxml) named instead of ignored globally; napalm_amt.driver is exempt for now (5 errors: getters return dicts where the role declares TypedDicts), recorded in tests/quality_baseline.json with get_event_log's complexity of 11. - Coverage floor 95 % (measured 95.87 %). - CHANGELOG.md in Keep a Changelog form; the README's development steps install from PyPI.
75 lines
3.4 KiB
Markdown
75 lines
3.4 KiB
Markdown
# napalm-amt
|
|
|
|
NAPALM driver for **Intel Active Management Technology (AMT)**, the management controller
|
|
built into Intel vPro business desktops, mini PCs and notebooks, over DMTF
|
|
WS-Management. Built on
|
|
[napalm-device-types](https://git.netork.io/NAPALM/napalm-device-types). Written for netOrk.
|
|
|
|
**Status: early development.** One driver, `amt` (`napalm_amt.AmtDriver`), a
|
|
`ManagementControllerDriver` from napalm-device-types like the server BMC drivers in
|
|
[napalm-redfish](https://git.netork.io/NAPALM/napalm-redfish). It reads the machine's
|
|
identity, hardware, firmware, power state and event log, reports what AMT listens on, and
|
|
switches the machine's power. It is tested against Intel's published recordings of an
|
|
AMT 12 (NUC9). Recordings of the first real test devices, two Lenovo ThinkCentre M910x
|
|
(AMT 11.x), are still to come.
|
|
|
|
## Why a driver of its own
|
|
|
|
AMT does the job of a server BMC (power control and inventory while the operating system
|
|
is down or the machine is off), but speaks a different protocol: no Redfish and no IPMI,
|
|
only WS-Management (SOAP, CIM classes) on port 16992, or 16993 with TLS. It shares
|
|
nothing with napalm-redfish beyond the role, so it lives here.
|
|
|
|
## Layout
|
|
|
|
| Entry point | Transport | Scope |
|
|
|---|---|---|
|
|
| `amt` | WS-Management over HTTP (16992) or HTTPS (16993), HTTP Digest auth | Read, plus power control; no reset of AMT itself |
|
|
|
|
`optional_args`: `port` (16992; 16993 means TLS), `tls` (overrides what the port
|
|
implies), `verify_ssl` (`True`, a CA file path, or `False`), `retries` (1).
|
|
|
|
The WS-Management client in `napalm_amt/wsman.py` is self-contained (requests, and
|
|
defusedxml to parse the answers). Neither `pywsman` (a C binding) nor `python-amt` (unmaintained, power only)
|
|
is used.
|
|
|
|
## What AMT knows, and what it does not
|
|
|
|
AMT reads the machine's SMBIOS: manufacturer, model, serial number, system UUID, CPUs,
|
|
DIMMs, drives (sizes only), BIOS version. It has no temperature, fan or power-supply
|
|
readings on client platforms, no core counts, and no drive models. Where it knows nothing,
|
|
the driver says so (`None`, empty) and does not guess. See [docs/amt-map.md](docs/amt-map.md).
|
|
|
|
AMT shares the machine's network controller. In DHCP mode it also uses the operating
|
|
system's IP address. netOrk keeps one device per address, so give AMT a static IP address
|
|
of its own in the MEBx ([docs/lenovo-m910x.md](docs/lenovo-m910x.md)).
|
|
|
|
## Documents
|
|
|
|
- [docs/amt-map.md](docs/amt-map.md): getters mapped to WS-Management classes
|
|
- [docs/security.md](docs/security.md): plain HTTP vs TLS, accounts, KVM, known CVEs
|
|
- [docs/lenovo-m910x.md](docs/lenovo-m910x.md): first test devices, MEBx setup, what to verify
|
|
- [docs/testing.md](docs/testing.md): fixtures, recording a real AMT
|
|
- [docs/references.md](docs/references.md)
|
|
|
|
## Development
|
|
|
|
The rules are in [STANDARDS.md](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
.venv/bin/pip install -e '.[dev]'
|
|
.venv/bin/pytest --cov
|
|
.venv/bin/ruff format --check . && .venv/bin/ruff check . && .venv/bin/mypy napalm_amt
|
|
```
|
|
|
|
## Conventions
|
|
|
|
These follow the other drivers in the `NAPALM` organisation:
|
|
|
|
- Role bases declare, they never implement. Generic logic goes into napalm-device-types,
|
|
vendor mechanics stay here.
|
|
- Parsing lives in pure functions (`napalm_amt/parsers/`), tested on recorded responses
|
|
under `tests/fixtures/<source>/`, with a `COMMANDS.txt` listing the request behind each
|
|
file.
|