python-neutronclient — Interactions

Interactions — python-neutronclient — branch stable/2026.2

Branch stable/2026.2 @ 596a9d99b188 (14.0.0 + 2 maintenance commits) — repository https://opendev.org/openstack/python-neutronclient — analysed on 2026-11-01

The package has no database, message bus, cache, file output or subprocess: a search of the non-test code finds no subprocess, getpass or input(, so no command had to be left out of the probes. It only sends REST calls. [observed] means seen on the local stub, which is not Neutron.

1. Keystone

The legacy v2 frame, [observed] python-api:

{"auth": {"passwordCredentials": {"username": "u", "password": "p"}, "tenantName": "n"}}

2. Neutron

URL building

A catalog URL ending in /v2.0 therefore gives /network/v2.0/v2.0/log/logs on binding commands (404 on the stub) and /network/v2.0/sfc/port_chains on SDK commands [observed catalog-v2-log, catalog-v2-sfc].

The stub's version document needed no fix for this plugin: neither stack asks for it.

Request headers [observed]

Query strings and bodies

• List: GET with urlencode(params, doseq=1) (neutronclient/v2_0/client.py:282). network log list sends no parameter, and SFC lists send none either [observed].
• Lookup through the class: ?id=<uuid> when the value starts with a UUID, because re.match is not anchored at the end (neutronclient/v2_0/client.py:427); then ?name=<value>. find_resourceid_by_name_or_id adds fields=id (neutronclient/neutron/v2_0/__init__.py:53) [observed: /v2.0/security-groups?name=x&fields=id].
• Lookup through the SDK: GET /sfc/port_chains/{name}, then on 404 GET /sfc/port_chains?name= [observed]. Two entries of the same name are refused by the SDK [inferred, openstacksdk:openstack/resource.py:2492].
• Pagination: the class follows the rel=next link of <collection>_links, keeps only its query and re-parses it (neutronclient/v2_0/client.py:383-401) [observed log-list-pagination]. The SDK does likewise for port_chains_links (openstacksdk:openstack/resource.py:2388) [observed sdk-list-pagination]. With page_reverse, the class follows previous.
• Bodies: one envelope key, the singular resource: {"log": {…}}, {"port_chain": {…}}. The exception is onboard_network_subnets, whose body has no envelope: {"network_id": "<id>"}. Serialisation falls back to str(obj) (neutronclient/common/serializer.py:49).

All routes, with their commands, are in the API surface, and the sample bodies are in § 4 of 01.

Sample exchange [observed log-create-sg]

GET /network/v2.0/security-groups?name=y
User-Agent: python-neutronclient
Accept: application/json
X-Auth-Token: stub-token

POST /network/v2.0/log/logs
Content-Type: application/json

{"log": {"resource_type": "security_group", "resource_id": "9c96e6ac-51f4-5ad3-add1-5f6deffde30f", "event": "DROP", "name": "n"}}

Statuses accepted

The class treats 200, 201, 202 and 204 as success (neutronclient/v2_0/client.py:291-294). Everything else goes through the error path of 02, including a 3xx that keystoneauth did not follow.

Retry and timeout

Nova and Heat pass connect_retries to the Adapter instead (nova:nova/network/neutron.py:237, heat:heat/engine/clients/os/neutron/__init__.py:66).

Response fields read by the commands

Only what the client reads, not what a service may send.

3. Other projects using the library

Details are in 07 § 4. All build a Client from a keystoneauth session, so none uses HTTPClient.

Source: reverse-spec-python-neutronclient/03-interactions_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.