INC Platform - Network Element-Level Management

Obtain Transceiver Information

Obtain transceiver information by device ID and interface index. The interface index is optional, and if not set, the system displays information about all transceiver modules of the device.

Interface URI

/webdm/transceiverinfo/transceiver

Access Method

HTTP
GET
Parameters
Query Parameter
devId Device ID.
Integer type. Required. No default value.
ifIndex Interface index.
Integer type. Required. No default value.

Return values

Status codes
200(OK): Succeeded.
Message header
HTTP/1.1 200 OK
Message body
{
  "transceiverAllResult": [
    {
      "ifIndex": "49",
      "waveLength": "850",
      "waveLengthUnit": "nm",
      "type": "10G_BASE_SR_SFP",
      "hardwareType": "MM",
      "distance": "300",
      "distanceUnit": "meter",
      "maxRXPower": "-100",
      "maxTXPower": "-100",
      "minRXPower": "-750",
      "minTXPower": "-730",
      "powerUnit": "dBM%"
    },
    {
      "ifIndex": "50",
      "waveLength": "850",
      "waveLengthUnit": "nm",
      "type": "10G_BASE_SR_SFP",
      "hardwareType": "MM",
      "distance": "300",
      "distanceUnit": "meter",
      "maxRXPower": "-100",
      "maxTXPower": "-100",
      "minRXPower": "-750",
      "minTXPower": "-730",
      "powerUnit": "dBM%"
    }
  ]
}
Element description
Subelements
waveLength Wave length,Unit: Nanometer.
Integer type.
type Transceiver module type.
String type,such as SFP/XFP/GBIC.
hardwareType Hardware type of the transceiver module, which can be single-mode or multi-mode.
String type,Such as SM(single mode).
distance Fiber port transmission distance,Unit: meter.
Integer type.
maxRXPower Input optical power upper threshold of the transceiver module,Unit: dBm.
Integer type.
minRXPower Input optical power lower threshold of the transceiver module,Unit: dBm.
Integer type.
maxTXPower Output optical power upper threshold of the transceiver module,Unit: dBm.
Integer type.
minTXPower Output optical power lower threshold of the transceiver module,Unit: dBm.
Integer type.

Example

Obtain information about the transceiver module with device ID 2 and interface index 49.

Request
GET http://127.0.0.1:8080/imcrs/webdm/transceiverinfo/transceiver?devId=2&ifIndex=49
accept: application/json
...
Response
{
  "transceiverAllResult": {
    "ifIndex": "49",
    "waveLength": "850",
    "waveLengthUnit": "nm",
    "type": "10G_BASE_SR_SFP",
    "hardwareType": "MM",
    "distance": "300",
    "distanceUnit": "meter",
    "maxRXPower": "-100",
    "maxTXPower": "-100",
    "minRXPower": "-750",
    "minTXPower": "-730",
    "powerUnit": "dBM%"
  }
}