Transceiver

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/running/interfaces/{name}/transceiver	Y	Y	Y	N	Y
/rest/v1/rpc/sfp-reset	N	Y	N	N	N
/rest/v1/rpc/show-interface-transceiver-eeprom	N	Y	N	N	N
/rest/v1/rpc/show-interface-transceiver-error-status	N	Y	N	N	N
/rest/v1/rpc/show-interface-transceiver-lpmode	N	Y	N	N	N
/rest/v1/rpc/show-interface-transceiver-presence	N	Y	N	N	N

Examples

SPF reset

POST HTTPS://{switch IP}/rest/v1/rpc/sfp-reset

POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-transceiver-error-status

response：

{
    "entry": [
        {
            "interface": "Ethernet1",
            "error-status": "OK"
        },
        ......
        {
            "interface": "Ethernet56",
            "error-status": "Unplugged"
        }
    ]
}

POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-transceiver-lpmode

response:

{
    "entry": [
        {
            "interface": "Ethernet1",
            "low-power-mode": "Not support"
        },
        ......
        {
            "interface": "Ethernet56",
            "low-power-mode": "Not support"
        }
    ]
}

POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-transceiver-eeprom
{
    "detail": "true"
}

response:

{
    "eeprom": [
        {
            "interface": "Ethernet1",
            "status": "SFP EEPROM detected",
            "detected": true,
            "monitor-data": {
                "group": [
                    {
                        "name": "MonitorData",
                        "item": [
                            {
                                "name": "RXPower",
                                "value": "-3.615dBm"
                            },
                            {
                                "name": "TXBias",
                                "value": "6.264mA"
                            },
                            {
                                "name": "TXPower",
                                "value": "-1.113dBm"
                            },
                            {
                                "name": "Temperature",
                                "value": "45.867C"
                            },
                            {
                                "name": "Vcc",
                                "value": "3.251Volts"
                            }
                        ]
                    }
                ]
            },
            "threshold-data": {
                "group": [
                    {
                        "name": "ThresholdData",
                        "item": [
                            {
                                "name": "TempHighAlarm",
                                "value": "85.0C"
                            },
                            {
                                "name": "TempHighWarning",
                                "value": "80.0C"
                            },
                            {
                                "name": "TempLowAlarm",
                                "value": "-10.0C"
                            },
                            {
                                "name": "TempLowWarning",
                                "value": "-5.0C"
                            },
                            {
                                "name": "VccHighAlarm",
                                "value": "3.6Volts"
                            },
                            {
                                "name": "VccHighWarning",
                                "value": "3.5Volts"
                            },
                            {
                                "name": "VccLowAlarm",
                                "value": "2.8Volts"
                            },
                            {
                                "name": "VccLowWarning",
                                "value": "2.9Volts"
                            },
                            {
                                "name": "RxPowerHighAlarm",
                                "value": "1.0dBm"
                            },
                            {
                                "name": "RxPowerHighWarning",
                                "value": "0.0dBm"
                            },
                            {
                                "name": "RxPowerLowAlarm",
                                "value": "-15.003dBm"
                            },
                            {
                                "name": "RxPowerLowWarning",
                                "value": "-14.001dBm"
                            },
                            {
                                "name": "TxBiasHighAlarm",
                                "value": "15.0mA"
                            },
                            {
                                "name": "TxBiasHighWarning",
                                "value": "12.0mA"
                            },
                            {
                                "name": "TxBiasLowAlarm",
                                "value": "0.5mA"
                            },
                            {
                                "name": "TxBiasLowWarning",
                                "value": "1.0mA"
                            },
                            {
                                "name": "TxPowerHighAlarm",
                                "value": "1.0dBm"
                            },
                            {
                                "name": "TxPowerHighWarning",
                                "value": "0.0dBm"
                            },
                            {
                                "name": "TxPowerLowAlarm",
                                "value": "-9.003dBm"
                            },
                            {
                                "name": "TxPowerLowWarning",
                                "value": "-8.002dBm"
                            }
                        ]
                    }
                ]
            },
            "attribute": [
                {
                    "name": "Application Advertisement",
                    "value": "N/A"
                },
                {
                    "name": "Connector",
                    "value": "LC"
                },
                {
                    "name": "Encoding",
                    "value": "64B/66B"
                },
                {
                    "name": "Extended Identifier",
                    "value": "GBIC/SFP defined by two-wire interface ID"
                },
                {
                    "name": "Extended RateSelect Compliance",
                    "value": "Unknown"
                },
                {
                    "name": "Identifier",
                    "value": "SFP/SFP+/SFP28"
                },
                {
                    "name": "Length OM3(10m)",
                    "value": "30.0"
                },
                {
                    "name": "Nominal Bit Rate(100Mbs)",
                    "value": "103"
                },
                {
                    "name": "Vendor Date Code(YYYY-MM-DD Lot)",
                    "value": "2019-07-10"
                },
                {
                    "name": "Vendor Name",
                    "value": "OEM"
                },
                {
                    "name": "Vendor OUI",
                    "value": "00-00-00"
                },
                {
                    "name": "Vendor PN",
                    "value": "TSSP85B33CDL03"
                },
                {
                    "name": "Vendor Rev",
                    "value": "A"
                },
                {
                    "name": "Vendor SN",
                    "value": "STST85S92800131"
                },
                {
                    "name": "Wavelength",
                    "value": "850.0 nm"
                }
            ],
            "section": [
                {
                    "name": "Specification compliance",
                    "item": [
                        {
                            "name": "10G Ethernet Compliance",
                            "value": "10GBASE-SR"
                        },
                        {
                            "name": "Extended Specification Compliance",
                            "value": "Unspecified"
                        },
                        {
                            "name": "Fibre Channel Link Length",
                            "value": "Intermediate distance (I)"
                        },
                        {
                            "name": "Fibre Channel Transmitter Technology",
                            "value": "Shortwave laser w/o OFC (SN)"
                        },
                        {
                            "name": "Secondary Extended Specification Compliance",
                            "value": "Unspecified"
                        }
                    ]
                }
            ]
        },
        ......
        {
            "interface": "Ethernet56",
            "status": "SFP EEPROM Not detected",
            "detected": true,
            "attribute": [],
            "section": []
        }
    ]
}

POST HTTPS://{switch IP}/rest/v1/rpc/show-interface-transceiver-presence

response:

{
    "entry": [
        {
            "interface": "Ethernet1",
            "presence": "Present"
        },
        ......
        {
            "interface": "Ethernet56",
            "presence": "Not present"
        }
    ]
}

Create transceiver for interface

POST HTTPS://{switch IP}/rest/v1/running/interfaces/Ethernet1/transceiver
{
    "lpmode": "true"
}

Properties Descriptions

Interface Transceiver

Tree Diagrams

  +--rw interfaces
     +--rw interface* [name]
        +--rw transceiver
        +--rw lpmode?

Table of Properties

Name	Required	Type/Range	Description
interfaces	M		Path-only node, has no configurable value.
Interface parameters.
name	M	Ethernet name	(sub-property of interfaces)
The name of the interface.
transceiver	M		(sub-property of interfaces)
Path-only node, has no configurable value.
lpmode	O	”true"
"false”	(sub-property of transceiver)
low-power mode for interface SFP transceiver module.
Default value: “false”

SPF reset

Tree Diagrams

    +---x sfp-reset
    |  +---w input
    |     +---w interface

Table of Properties

Name	Required	Type/Range	Description
sfp-reset	M		Path-only node, has no configurable value.
Reset interface SFP transceiver module.
interface	M	Ethernet name	(sub-property of input)

Tree Diagrams

    +---x show-interface-transceiver-error-status
    |  +---w input
    |  |  +---w interface?
    |  +--ro output
    |     +--ro entry* [interface]
    |     |  +--ro interface
    |     |  +--ro error-status?
    |     +--ro raw-result?

Table of Properties

Name	Required	Type/Range	Description
show-interface-transceiver-error-status	M		Path-only node, has no configurable value.
Show error status information of SFP transceiver.
interface	O	Ethernet name	(sub-property of input)

                                                                 |

| entry | RO | | (sub-property of output) Path-only node, has no configurable value. | | interface | RO | string | (sub-property of entry) | | error-status | RO | string | (sub-property of entry) | | raw-result | RO | string | (sub-property of output) Original CLI output for compatibility and rendering. |

Show interface transceiver low power mode

Tree Diagrams

    +---x show-interface-transceiver-lpmode
    |  +---w input
    |  |  +---w interface?
    |  +--ro output
    |     +--ro entry* [interface]
    |     |  +--ro interface
    |     |  +--ro low-power-mode?
    |     +--ro raw-result?

Table of Properties

Name	Required	Type/Range	Description
show-interface-transceiver-lpmode	M		Path-only node, has no configurable value.
Show low-power mode information of SFP transceiver.
interface	O	Ethernet name	(sub-property of input)

                                                                   |

| entry | RO | | (sub-property of output) Path-only node, has no configurable value. | | interface | RO | string | (sub-property of entry) | | low-power-mode | RO | string | (sub-property of entry) | | raw-result | RO | string | (sub-property of output) Original CLI output for compatibility and rendering. |

Show interface transceiver presence

Tree Diagrams

    +---x show-interface-transceiver-presence
    |  +---w input
    |  |  +---w interface?
    |  +--ro output
    |     +--ro entry* [interface]
    |     |  +--ro interface
    |     |  +--ro presence?
    |     +--ro raw-result?

Table of Properties

Name	Required	Type/Range	Description
show-interface-transceiver-presence	M		Path-only node, has no configurable value.
Show presence information of SFP transceiver.
interface	O	Ethernet name	(sub-property of input)

                                                             |

| entry | RO | | (sub-property of output) Path-only node, has no configurable value. | | interface | RO | string | (sub-property of entry) | | presence | RO | string | (sub-property of entry) | | raw-result | RO | string | (sub-property of output) Original CLI output for compatibility and rendering. |

Tree Diagrams

    +---x show-interface-transceiver-eeprom
       +---w input
       |  +---w interface?
       |  +---w detail?
       +--ro output
          +--ro eeprom* [interface]
          |  +--ro interface
          |  +--ro status?
          |  +--ro detected?
          |  +--ro attribute* [name]
          |  |  +--ro name
          |  |  +--ro value?
          |  +--ro section* [name]
          |  |  +--ro name
          |  |  +--ro item* [name]
          |  |     +--ro name
          |  |     +--ro value?
          |  +--ro monitor-data
          |  |  +--ro group* [name]
          |  |     +--ro name
          |  |     +--ro item* [name]
          |  |        +--ro name
          |  |        +--ro value?
          |  +--ro threshold-data
          |     +--ro group* [name]
          |        +--ro name
          |        +--ro item* [name]
          |           +--ro name
          |           +--ro value?
          +--ro raw-result?

Table of Properties

Name	Required	Type/Range	Description
show-interface-transceiver-eeprom	M		Path-only node, has no configurable value.
Show Electrically Erasable Programmable ROM(EEPROM) information of SFP transceiver.
interface	O	Ethernet name	(sub-property of input)

                                                                                                                                                                              |

| detail | O | “true” “false” | (sub-property of input) Digital Optical Monitoring (DOM) data. | | eeprom | RO | | (sub-property of output) Path-only node, has no configurable value. | | interface | RO | string | (sub-property of eeprom) | | status | RO | string | (sub-property of eeprom) | | detected | RO | “true” “false” | (sub-property of eeprom) True if the module is detected according to the CLI status line. | | attribute | RO | | (sub-property of eeprom) Path-only node, has no configurable value. | | name | RO | string | (sub-property of attribute) | | value | RO | string | (sub-property of attribute) | | section | RO | | (sub-property of eeprom) Path-only node, has no configurable value. | | name | RO | string | (sub-property of section) | | item | RO | | (sub-property of section) Path-only node, has no configurable value. | | name | RO | string | (sub-property of item) | | value | RO | string | (sub-property of item) | | monitor-data | RO | | (sub-property of eeprom) Path-only node, has no configurable value. DOM monitor values grouped by the CLI section name, for example MonitorData, ChannelMonitorValues or ModuleMonitorValues. | | group | RO | | (sub-property of monitor-data) Path-only node, has no configurable value. | | name | RO | string | (sub-property of group) | | item | RO | | (sub-property of group) Path-only node, has no configurable value. | | name | RO | string | (sub-property of item) | | value | RO | string | (sub-property of item) | | threshold-data | RO | | (sub-property of eeprom) Path-only node, has no configurable value. DOM threshold values grouped by the CLI section name, for example ThresholdData, ChannelThresholdValues or ModuleThresholdValues. | | group | RO | | (sub-property of threshold-data) Path-only node, has no configurable value. | | name | RO | string | (sub-property of group) | | item | RO | | (sub-property of group) Path-only node, has no configurable value. | | name | RO | string | (sub-property of item) | | value | RO | string | (sub-property of item) | | raw-result | RO | string | (sub-property of output) Original CLI output for compatibility and rendering. |