OLT Pon Port

6 operations. Call any of them with omada_call_operation (or, in full tool mode, as a tool named by its operationId).

Operation	Method	Summary
getPonPortList	GET	Get pon port list
getPonPortPage	GET	Get pon port page
editPonPort	POST	Batch modify pon port
getPonPortInformationList	GET	Get pon port information list
getPonPortInformationPage	GET	Get pon port information page
getPonPortListMsp	GET	Get pon port list(msp mode)

getPonPortList

GET /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/list

Get pon port list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

// omada_call_operation
{
  "operationId": "getPonPortList",
  "params": {
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  }
}

Details, permissions and error codes

Get pon port list
The interface requires one of the permissions:
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.

getPonPortPage

GET /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/page

Get pon port page

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF
queryParam	query	BaseDevicePageQueryRequest	no	Object: its fields (searchKey, sorts, size, number) are sent as separate query parameters.

// omada_call_operation
{
  "operationId": "getPonPortPage",
  "params": {
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  }
}

Details, permissions and error codes

Get pon port page
The interface requires one of the permissions:
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.

editPonPort

POST /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/edit

Batch modify pon port

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

Request body — application/json (required) — schema PonPortBatchModifyDTO

Field	Type	Required	Description
dtos	array<PonPortModifyDTO>	yes

// omada_call_operation
{
  "operationId": "editPonPort",
  "params": {
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Batch modify pon port
The interface requires one of the permissions:
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.
-45013 - Pon port does not exist.

getPonPortInformationList

GET /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/informations/list

Get pon port information list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

// omada_call_operation
{
  "operationId": "getPonPortInformationList",
  "params": {
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  }
}

Details, permissions and error codes

Get pon port information list
The interface requires one of the permissions:
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.

getPonPortInformationPage

GET /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/informations/page

Get pon port information page

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF
queryParam	query	BaseDevicePageQueryRequest	no	Object: its fields (searchKey, sorts, size, number) are sent as separate query parameters.

// omada_call_operation
{
  "operationId": "getPonPortInformationPage",
  "params": {
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  }
}

Details, permissions and error codes

Get pon port information page
The interface requires one of the permissions:
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.

getPonPortListMsp

GET /openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/list

Get pon port list(msp mode)

Parameter	In	Type	Required	Description
mspId	path	string	auto	mspId (filled in automatically)
customerId	path	string	yes	customerId
siteId	path	string	yes	Site ID (site ID or site name)
deviceMac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF

// omada_call_operation
{
  "operationId": "getPonPortListMsp",
  "params": {
    "customerId": "<customerId>",
    "siteId": "<siteId>",
    "deviceMac": "<deviceMac>"
  }
}

Details, permissions and error codes

Get pon port list(msp mode)
The interface requires one of the permissions:
MSP Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-45000 - This OLT does not exist.
-45001 - The OLT is offline. Please reconnect
-45002 - OLT upgrading... Cannot manage the device now.
-45003 - OLT rebooting... Cannot manage the device now.