Skip to content

request.md

Latest commit

 

History

History
101 lines (78 loc) · 4.23 KB

request.md

File metadata and controls

101 lines (78 loc) · 4.23 KB

Common Request

Shared Request Body Patterns For PyPNM Endpoints.

When using Swagger UI, many parameters auto-fill from system settings. See System Configuration. For fields that accept defaults, use null to request the system.json value. Blank strings are rejected.

PNM Operations With File Retrieval (TFTP)

Use this when the endpoint retrieves a file (for example, an RxMER capture written to a TFTP server).

{
  "cable_modem": {
    "mac_address": "aa:bb:cc:dd:ee:ff",
    "ip_address": "192.168.0.100",
    "pnm_parameters": {
      "tftp": {
        "ipv4": null,
        "ipv6": "2001:db8::10"
      },
      "capture": {
        "channel_ids": []
      }
    },
    "snmp": {
      "snmpV2C": {
        "community": null
      }
    }
  }
}

SNMP-Only Operations (No File Retrieval)

Use this when the endpoint performs SNMP calls only.

{
  "cable_modem": {
    "mac_address": "aa:bb:cc:dd:ee:ff",
    "ip_address": "192.168.0.100",
    "snmp": {
      "snmpV2C": {
        "community": "private"
      }
    }
  }
}

Field Summary

Cable Modem

Field Type Notes
cable_modem.mac_address string Accepts multiple formats; case-insensitive. Examples: aa:bb:cc:dd:ee:ff, aa-bb-cc-dd-ee-ff, aabb.ccdd.eeff, aabbccddeeff. Normalized internally.
cable_modem.ip_address string Target CM IPv4 or IPv6 address.

TFTP (Only For File-Retrieval Endpoints)

Field Type Notes
pnm_parameters.tftp.ipv4 string|null IPv4 of the TFTP server; null uses system.json.
pnm_parameters.tftp.ipv6 string|null IPv6 of the TFTP server; null uses system.json.

Capture Filters (Optional)

Field Type Notes
pnm_parameters.capture.channel_ids int[] Optional list of channel IDs to target. Empty or missing means all.

SNMP (Choose One: v2c Or v3)

SNMPv2c

Field Type Notes
snmp.snmpV2C.community string|null Read/write community key; null uses system.json.

SNMPv3

SNMPv3 must be enabled in System Configuration. (Not implemented yet.)

Field Type Notes
snmp.snmpV3.username string SNMPv3 username.
snmp.snmpV3.securityLevel string One of noAuthNoPriv, authNoPriv, authPriv.
snmp.snmpV3.authProtocol string For example MD5, SHA.
snmp.snmpV3.authPassword string Required if using auth*.
snmp.snmpV3.privProtocol string For example DES, AES.
snmp.snmpV3.privPassword string Required if using *Priv.

Notes

  • For analysis endpoints, pnm_parameters is top-level (not nested under cable_modem). Example: { "cable_modem": {...}, "pnm_parameters": {...}, "analysis": {...}, "output": {...} }.
  • Choose either SNMPv2c or SNMPv3 fields—do not mix both in a single request.
  • For TFTP and SNMP override fields, null requests system.json defaults and blank strings are invalid.