Environmental Monitoring

Querying the Module Temperature Sensor Data

Querying the Module Temperature Sensor Data
GET http://<IP_Address>/api/mo/sys/ch/supslot-1/sup/sensor-1.json
{
  "eqptSensor": {
    "attributes": {
      "childAction": "",
      "descr": "FRONT",
      "dn": "sys/ch/supslot-1/sup/sensor-1",
      "id": "1",
      "majorThresh": "70",
      "mfgTm": "not-applicable",
      "minorThresh": "42",
      "modTs": "2017-06-06T22:11:05.299+00:00",
      "model": "FRONT",
      "monPolDn": "",
      "operSt": "normal",
      "persistentOnReload": "false",
      "rev": "n/a",
      "ser": "n/a",
      "status": "",
      "tempValue": "25",
      "type": "inlet",
      "unit": "Celsius",
      "vendor": "Cisco Systems"
    }
  }
}

Provides sensor data for environmental monitors such as temperature gauges.


CLI Commands

The DME payload is the equivalent of the sensor name (descr), MajorThresh (majorThresh), MinorThres (minorThresh), CurTemp (tempValue), status (operSt), and the temperature scale (unit) given in the first row of the show environment temperature module module output table. Compare the payload with the CLI Output.

CLI Output
 switch# show environment temperature module 1    
 Temperature:    
 -----------------------------------------------------------------------    
 Module   Sensor      MajorThresh      MinorThres   CurTemp   Status	  
                        (Celsius)     (Celsius)  (Celsius)    
 ----------------------------------------------------------------------- 
 1       FRONT          70               42          25         Ok   
 1       BACK           80               70          33         Ok    
 1       CPU            95               80          34         Ok    
 1       TH             105              90          50         Ok    
 1       VRM-1          110              100         50         Ok 

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
eqptSensor sys/ch/supslot-{id}/sup/sensor-{id}


eqptSensor Properties

The following table contains information about the eqptSensor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
childAction
mo:ModificationChildAction
scalar:Bitmask32
Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
  • descreqpt:Descr
    Description of the specified attribute
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    ideqpt:Id
    (scalar:Uint32)
    The item identifier.
    RANGE: [1 , 32]
    majorThresheqpt:TempThresh
    (scalar:Sint16)
    The major threshold of the sensor.RANGE: [-32768 , 32767]
    mfgTm
    scalar:Date
    The manufacturing time.SELECTION:
  • 0ull - not-applicable
  • DEFAULT: not-applicable(0ull)
  • minorThresheqpt:TempThresh
    (scalar:Sint16)
    The minor threshold of the sensor.RANGE: [-32768 , 32767]
    modTsmo:TStamp
    (scalar:Date)
    The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    modeleqpt:Model
    (string:Basic)
    ModelA sequence of characters
    monPolDn
    reference:BinRef
    The monitoring policy attached to this observable object.
    operSteqpt:SensorOpSt
    (scalar:Enum8)
    The runtime state.SELECTION:
    0 - fail
    1 - normal
    2 - minor
    3 - major
    4 - absent
    5 - bad-asic
    DEFAULT: absent
    persistentOnReload
    mo:Persistent
    scalar:Enum8
    NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
  • rev
    eqpt:Revision
    string:Basic
    The revision number. RANGE: Min: "0" Max: "512"
  • DEFAULT: "0"
  • ser
    eqpt:Serial
    string:Basic
    The serial number. RANGE: Min: "0" Max: "16"
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    tempValueeqpt:TempValue
    (scalar:Uint16)
    The equipment sensor temperature valueRANGE: [0, 65535]
    DEFAULT: 0
    typeeqpt:SensorT
    (scalar:Enum8)
    The type of sensor.SELECTION:
    1 - cpu
    2 - inlet
    3 - outlet
    4 - hotswap
    5 - dimm
    6 - phy
    7 - sfp
    8 - qsfp
    9 - asic
    10 - pch
    11 - cpu-crm
    12 - asic-vrm
    18 - x86
    19 - arm
    20 - die
    DEFAULT: asic
    unitstring:Basic
    The equipment sensor temperature unitA sequence of characters
    vendoreqpt:Vendor
    (string:Basic)
    VendorA sequence of characters
    DEFAULT: Cisco Systems, Inc


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

    https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

    For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

    Querying the Power Supply Data

    Querying the Power Supply Data 
    
    GET http://<IP_Address>/api/mo/sys/ch/psuslot-1/psu.json
    
    {
      "eqptPsu": {
        "attributes": {
          "almReg": "0",
          "cap": "54.000000",
          "childAction": "",
          "descr": "NXA-PAC-650W-PI-1",
          "dn": "sys/ch/psuslot-1/psu",
          "drawnCurr": "0.422727",
          "fanOpSt": "ok",
          "hwVer": "V01",
          "id": "1",
          "mfgTm": "not-applicable",
          "modTs": "2017-06-06T22:21:40.321+00:00",
          "model": "NXA-PAC-650W-PI",
          "monPolDn": "",
          "operSt": "ok",
          "persistentOnReload": "false",
          "rev": "A0",
          "ser": "LIT192818FC",
          "status": "",
          "vSrc": "220v",
          "vendor": "Cisco Systems Inc",
          "volt": "12.000000"
        }
      }
    }
    
    

    Provides system inventory power supply information.


    CLI Commands

    The DME payload provides information on PID (model), VID (hwVer), and SN (ser) numbers given in the show inventory power_supply output and provides the voltage (volt), ampere input (drawnCurr), and status (operSt) given in the show environment power ampere output. Compare the payload with the CLI Output.

    CLI Output
     switch# show inventory power_supply    
     NAME: "Power Supply 1",  DESCR:"Nexus3000 C3232C Chassis Power Supply"       
     PID: NXA-PAC-650W-PI     ,  VID: V01 ,  SN: LIT192818FC 
     
    CLI Output
     switch# show environment power ampere      
     Power Supply:    
     Voltage: 12 Volts    
     Power                             Actual      Actual        Total    
     Supply    Model                  Output      Input      Capacity    Status    
                                    (Ampere)    (Ampere)     (Ampere)    
     -------  -------------------  ----------  ----------  ----------  ------------   	  
     1        NXA-PAC-650W-PI 
     6.58 A   0.42 A    54.16 A     Ok        
     2        NXA-PAC-650W-PI        5.92 A   0.39 A    54.16 A     Ok      
    

    Note: The property information for this example was added in Release 9.3(3).


    Verifying a DME Configuration
    The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

    MODN
    eqptPsu sys/ch/psuslot-{id}/psu


    eqptPsu Properties

    The following table contains information about the eqptPsu properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

    Property NameData TypeDescriptionValues
    almReg
    scalar:Uint16
    The power supply alarm register.
    capeqpt:Amps
    (scalar:Float)
    The power supply capacity in milli amps.A floating number per IEEE-754 standard
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32
    Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
  • descreqpt:Descr
    Description of the specified attribute
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    drawnCurreqpt:Amps
    (scalar:Float)
    The power supply unit actual drawn/output currentA floating number per IEEE-754 standard
    fanOpSteqpt:OpSt
    (scalar:Enum8)
    The power supply fan's operational status.SELECTION:
    0 - unknown
    1 - ok
    2 - fail
    3 - absent
    4 - shut
    5 - mismatch
    DEFAULT: unknown
    hwVercap:Version
    (string:Basic)
    The hardware version of a card.A sequence of characters
    ideqpt:Id
    (scalar:Uint32)
    The item identifier.RANGE: [0, 4294967295]
    mfgTmscalar:Date
    Manufacturing TimeDATE FORMAT: %Y-%m-%dT%H:%M:%S.%f%z
    DEFAULT: not-applicable
    modTsmo:TStamp
    (scalar:Date)
    The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    modeleqpt:Model
    (string:Basic)
    ModelA sequence of characters
    monPolDn
    reference:BinRef
    The monitoring policy associated with the power supply.
    operSteqpt:OpSt
    (scalar:Enum8)
    The power supply status.SELECTION:
    0 - unknown
    1 - ok
    2 - fail
    3 - absent
    4 - shut
    5 - mismatch
    DEFAULT: unknown
    persistentOnReload
    mo:Persistent
    scalar:Enum8
    NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
  • reveqpt:Revision
    (string:Basic)
    RevisionA sequence of characters
    DEFAULT: 0
    sereqpt:Serial
    (naming:Name)
    Serial Number
    MAX SIZE: 16
    statusmo:ModificationStatus
    (scalar:Bitmask32)
    The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced
    vSrceqpt:VSrc
    (scalar:Enum8)
    The power supply voltage source.SELECTION:
    0 - unknown
    1 - 110v
    2 - 220v
    DEFAULT: unknown
    vendoreqpt:Vendor
    (string:Basic)
    VendorA sequence of characters
    DEFAULT: Cisco Systems, Inc
    volteqpt:Volts
    (scalar:Float)
    The power supply voltage.A floating number per IEEE-754 standard


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

    https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

    For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

    Querying the Transceiver Data

    Querying the Transceiver Data
    
    GET http://<IP_Address>/api/mo/sys/intf/phys-[eth2/2]/phys/fcot.json
    
    {
     "ethpmFcot": {
        "attributes": {
          "baseResvd1": "0",
          "baseResvd2": "0",
          "baseResvd3": "0",
          "baseResvd4": "7,208,70",
          "brIn100MHz": "103",     
          "brMaxMargin": "15",     
          "brMinMargin": "222",    
          "ccex": "162",           
          "ccid": "104",           
          "connectType": "12",     
          "dateCode": "49,50,48,50,49,50,32,32",
          "description": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0",
          "diagMonType": "10",                                       
          "distIn100mFor9u": "50",                                   
          "distIn10mFor50u": "30",                                   
          "distIn10mFor60u": "0",                                    
          "distIn1mForCu": "0",                                      
          "distInKmFor9u": "0",                                      
          "dn": "sys/intf/phys-[eth2/2]/phys/fcot",                  
          "encoding": "5",                                           
          "enhOption": "0",                                          
          "extOption": "0,0",                                        
          "fCTxType": "1",                                           
          "fcotNum": "98",                                           
          "fcotStatus": "0",                                         
          "fcotType": "19",                                          
          "flags": "ok",                                             
          "gigEthCC": "0",                                           
          "guiCiscoEID": "unknown",                                  
          "guiCiscoPID": "",                                         
          "guiCiscoPN": "",                                          
          "guiName": "CISCO           ",                             
          "guiPN": "AFBR-79EIPZ-CS1 ",                               
          "guiRev": "02Bh",                                          
          "guiSN": "AVP1606S381     ",                               
          "isFcotPresent": "yes",                                    
          "maxSpeed": "5",                                           
          "minSpeed": "5",                                           
          "partNumber": "0,0,0,0,0,0,0,0,0,0,0",                     
          "sff8472Compl": "0",                                       
          "state": "inserted",                                       
          "type": "qsfp",                                            
          "typeName": "",                                            
          "vendorData": "0,0,6,172,8,168,10,138,172,124,181,114,234,190,127,49,181,208,56,0,0,0,0,0,0,0,0,0,142,50,241,121",
          "vendorId": "0,23,106",                                                                                           
          "vendorName": "67,73,83,67,79,32,32,32,32,32,32,32,32,32,32,32",                                                  
          "vendorPn": "65,70,66,82,45,55,57,69,73,80,90,45,67,83,49,32",                                                    
          "vendorRev": "48,50,66,104",                                                                                      
          "vendorSn": "65,86,80,49,54,48,54,83,51,56,49,32,32,32,32,32",                                                    
          "versionId": "0,0,0,0,0",                                                                                         
          "xcvrCode": "4,0,0,0,0,0,0,0",                                                                                    
          "xcvrExtId": "16",                                                                                                
          "xcvrId": "13" 
        }
      }
    }
    
    

    Provides transceiver interface information.


    CLI Commands

    The DME payload provides the slot and port numbers (dn: sys/intf/phys-{[id]}...), interface name (guiName), part number (guiPN), serial number (guiSN), link length (distIn10mFor50u), and the Cisco extended ID number (xcvrExtId) given in the show interface ethernet slot/port transceiver output. Compare the payload with the CLI Output.

    CLI Output
     switch# show interface e2/2 transceiver    
     Ethernet2/2    
     transceiver is present    
     type is QSFP-40G-SR4    
     name is CISCO    
     part number is AFBR-79EIPZ-CS1    
     revision is 02    
     serial number is AVP1606S381    
     nominal bitrate is 10300 MBit/sec per channel    
     Link length supported for 50/125um OM2 fiber is 30 m    
     Link length supported for 50/125um OM3 fiber is 100 m    
     cisco id is 13    
     cisco extended id number is 16   
    

    Note: The property information for this example was added in Release 9.3(3).


    Verifying a DME Configuration
    The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

    MODN
    ethpmFcot sys/intf/phys-{[id]}/phys/fcot


    ethpmFcot Properties

    The following table contains information about the ethpmFcot properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

    Property NameData TypeDescriptionValues
    baseResvd1scalar:UByte
    Base Reserved FieldRANGE: [0, 255]
    baseResvd2scalar:UByte
    Base Reserved FieldRANGE: [0, 255]
    baseResvd3scalar:UByte
    Base Reserved FieldRANGE: [0, 255]
    baseResvd4ethpm:SfpReserved4Array
    (base:Uint8Array)
    Base Reserved Field
    ARRAY SIZE: 3
    brIn100MHzscalar:UByte
    Baud RateRANGE: [0, 255]
    brMaxMarginscalar:UByte
    Baud Rate Maximum MarginRANGE: [0, 255]
    brMinMarginscalar:UByte
    Baud Rate Minimum MarginRANGE: [0, 255]
    ccexscalar:UByte
    RANGE: [0, 255]
    ccidscalar:UByte
    CCIDRANGE: [0, 255]
    connectTypescalar:UByte
    Connector TypeRANGE: [0, 255]
    dateCodestring:Basic
    The vendor?s manufacturing date code.A sequence of characters
    descriptionstring:Basic
    Fcot descriptionA sequence of characters
    diagMonTypescalar:UByte
    RANGE: [0, 255]
    distIn100mFor9uscalar:UByte
    DistanceRANGE: [0, 255]
    distIn10mFor50uscalar:UByte
    DistanceRANGE: [0, 255]
    distIn10mFor60uscalar:UByte
    DistanceRANGE: [0, 255]
    distIn1mForCuscalar:UByte
    DistanceRANGE: [0, 255]
    distInKmFor9uscalar:UByte
    DistanceRANGE: [0, 255]
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    encodingscalar:UByte
    EncodingRANGE: [0, 255]
    enhOptionscalar:UByte
    RANGE: [0, 255]
    extOptionethpm:SfpExtendedOptionBytes
    (base:Uint8Array)
    Extended Option
    ARRAY SIZE: 2
    fCTxTypescalar:UByte
    The type of fibre channel transmitter.RANGE: [0, 255]
    fcotNumscalar:UByte
    The FCOT number. The device number that this info belongs to.RANGE: [0, 255]
    fcotStatusscalar:UByte
    Fcot statusRANGE: [0, 255]
    fcotTypescalar:UByte
    The transceiver type. This property is a numerical value.RANGE: [0, 255]
    flagsethpm:FcotFlags
    (scalar:Enum8)
    Fcot flagsSELECTION:
    0 - unknown
    1 - access-failed
    2 - checksum-failed
    3 - vendor-crc-failed
    4 - sfp-speed-mismatch
    5 - eth-compalint-failed
    6 - unknown-xcvr-type
    7 - emphasis-checksum-failed
    8 - init-failed
    9 - ok-auth-success-no-md5
    10 - auth-failed
    11 - ok-delayed-auth-success
    12 - delayed-auth-failed
    13 - ok-no-md5
    14 - ok
    DEFAULT: unknown
    gigEthCCscalar:UByte
    RANGE: [0, 255]
    guiCiscoEIDNANANA
    guiCiscoPIDNANANA
    guiCiscoPNNANANA
    guiNameNANANA
    guiPNNANANA
    guiRevNANANA
    guiSNNANANA
    isFcotPresentscalar:Bool
    Fcot presence statusSELECTION: true or false
    maxSpeedscalar:Uint32
    The nominal bitrate in MBits per sec.RANGE: [0, 4294967295]
    minSpeedscalar:Uint32
    The minimum speed of the interface.RANGE: [0, 4294967295]
    partNumberstring:Basic
    Fcot part numberA sequence of characters
    sff8472Complscalar:UByte
    RANGE: [0, 255]
    stateethpm:FcotState
    (scalar:Enum8)
    Fcot stateSELECTION:
    0 - unknown
    1 - inserted
    2 - removed
    3 - hw-failure
    4 - inserted-initializing
    DEFAULT: unknown
    typeethpm:FcotType
    (scalar:Enum8)
    Fcot typeSELECTION:
    0 - unknown
    1 - xfp
    2 - x2
    3 - dummy
    4 - sfp
    5 - qsfp
    6 - cfp-40g
    7 - cfp-100g
    8 - cfp
    9 - qsfp28
    10 - qsfpdd
    11 - cpak
    12 - qsfp56
    13 - cxp
    DEFAULT: unknown
    typeNamestring:Basic
    Type NameA sequence of characters
    vendorDataethpm:X2VendorDataBytes
    (base:Uint8Array)
    ARRAY SIZE: 32
    vendorIdethpm:SfpVendorIdBytes
    (base:Uint8Array)
    Vendor ID
    ARRAY SIZE: 3
    vendorNamestring:Basic
    Vendor NameA sequence of characters
    vendorPnstring:Basic
    Vendor Part NumberA sequence of characters
    vendorRevstring:Basic
    Vendor RevisionA sequence of characters
    vendorSnstring:Basic
    A sequence of characters
    versionIdstring:Basic
    Fcot version idA sequence of characters
    xcvrCodeethpm:SfpXcvrCodeBytes
    (base:Uint8Array)
    Transceiver Code
    ARRAY SIZE: 8
    xcvrExtIdscalar:UByte
    Transceiver Extended IDRANGE: [0, 255]
    xcvrIdscalar:UByte
    Transceiver IDRANGE: [0, 255]


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

    https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

    For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

    Querying the Transceiver Sensor Data

    Querying the Transceiver Sensor Data
    
    GET http://<IP_Address>/api/mo/sys/intf/phys-[eth2/2]/phys/fcot/lane-1-sensor-2.json
    
    {                                                                                                                 
    "eqptFcotSensor": {                                                                                             
      "attributes": {                                                                                               
        "description": "XCVR Lane-1 Sensor-2 Voltage Sensor",                                                       
        "dn": "sys/intf/phys-[eth2/2]/phys/fcot/lane-1-sensor-2",                                                   
        "highAlarm": "3.630000",                                                                                    
        "highWarning": "3.465000",                                                                                  
        "laneId": "1",                                                                                              
        "laneType": "basic",                                                                                        
        "lowAlarm": "2.970000",                                                                                     
        "lowWarning": "3.100000",                                                                                   
        "sensorId": "2",                                                                                            
        "unit": "V",                                                                                                
        "value": "3.403700"
      }
    }
    },
    
    
    

    Provides transceiver sensor information.


    CLI Commands

    The DME payload provides the lane number and voltage (description), curent measurement (value), alarms (highAlarm and lowAlarm), warnings (highWarning and lowWarning), and the sensor unit (unit) given in the show interface ethernet slot/port transceiver output. Compare the payload with the CLI Output.

    CLI Output
     switch# show interface e2/2 transceiver details     
     Ethernet2/2                                       
          transceiver is present                        
          type is QSFP-40G-SR4                         
          name is CISCO                                 
          part number is AFBR-79EIPZ-CS1                
          revision is 02                                
          serial number is AVP1606S381                  
          nominal bitrate is 10300 MBit/sec per channel     
          Link length supported for 50/125um OM2 fiber is 30 m     
          Link length supported for 50/125um OM3 fiber is 100 m     
          cisco id is 13                                            
          cisco extended id number is 16                            
    
    CLI Output
     Lane Number:1 Network Lane    
            SFP Detail Diagnostics Information (internal calibration)   
       ----------------------------------------------------------------------------    
                    Current                Alarms                   Warnings          
                    Measurement    High        Low        High         Low   
      ----------------------------------------------------------------------------     
      Temperature   24.65 C       75.00 C     -5.00 C     70.00 C      0.00 C   
      Voltage        3.40 V        3.63 V      2.97 V      3.46 V      3.09 V  
      Current           N/A           N/A       N/A       N/A            N/A   
      Tx Power          N/A           N/A       N/A       N/A            N/A    
      Rx Power          N/A           N/A       N/A       N/A            N/A   
      Transmit Fault Count = 0    
      ----------------------------------------------------------------------------    
      Note: ++  high-alarm; +  high-warning; --  low-alarm; -  low-warning    
     ...     
    

    Note: The property information for this example was added in Release 9.3(3).


    Verifying a DME Configuration
    The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

    MODN
    eqptFcotSensor sys/intf/phys-{[id]}/phys/fcot/lane-{laneId}-sensor-{sensorId}


    eqptFcotSensor Properties

    The following table contains information about the eqptFcotSensor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

    Property NameData TypeDescriptionValues
    descriptionstring:Basic
    The transceiver sensor descriptionA sequence of characters
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    highAlarmscalar:Float
    The transceiver sensor high alarm thresholdA floating number per IEEE-754 standard
    highWarningscalar:Float
    The transceiver sensor high warning thresholdA floating number per IEEE-754 standard
    laneIdscalar:Uint16
    The transceiver LANE identifierRANGE: [0, 65535]
    laneTypeeqpt:fcotDomLane
    (scalar:Enum8)
    The transceiver LANE typeSELECTION:
    0 - basic
    1 - extGlobal
    2 - extOptical
    lowAlarmscalar:Float
    The transceiver sensor low alarm thresholdA floating number per IEEE-754 standard
    lowWarningscalar:Float
    The transceiver sensor low warning thresholdA floating number per IEEE-754 standard
    sensorIdscalar:Uint16
    The transceiver sensor identifierRANGE: [0, 65535]
    unitstring:Basic
    The transceiver sensor unitA sequence of characters
    valuescalar:Float
    The transceiver sensor current valueA floating number per IEEE-754 standard


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

    https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

    For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

    Querying the Temperature Details for the Sensor

    Querying the Temperature Details for the Sensor
    
    GET http://<IP_Address>/api/mo/sys/intf/phys-[eth2/2]/phys/fcot/lane-1-sensor-1.json
    
    {
      "totalCount": "1",
      "imdata": [
        {
          "eqptFcotSensor": {
            "attributes": {
              "description": "XCVR Lane-1 Sensor-1 Temperature Sensor",
              "dn": "sys/intf/phys-[eth2/2]/phys/fcot/lane-1-sensor-1",
              "highAlarm": "75.000000",
              "highWarning": "70.000000",
              "laneId": "1",
              "laneType": "basic",
              "lowAlarm": "-5.000000",
              "lowWarning": "0.000000",
              "sensorId": "1",
              "unit": "C",
              "value": "25.058001"
            }
          }
        }
      ]
    }
    
    
    

    Provides transceiver sensor information.


    CLI Commands

    The DME payload provides the lane number and voltage (description), current measurement (value), alarms (highAlarm and lowAlarm), warnings (highWarning and lowWarning), and the sensor unit (unit) given in the show interface ethernet slot/port transceiver output. Compare the payload with the CLI Output.

    CLI Output
      switch# show interface e2/2 transceiver details   
     Ethernet2/2                                       
          transceiver is present                        
          type is QSFP-40G-SR4                          
          name is CISCO                                 
          part number is AFBR-79EIPZ-CS1               
          revision is 02                                
          serial number is AVP1606S381                  
          nominal bitrate is 10300 MBit/sec per channel     
          Link length supported for 50/125um OM2 fiber is 30 m     
          Link length supported for 50/125um OM3 fiber is 100 m     
          cisco id is 13                                            
          cisco extended id number is 16                           
     Lane Number:1 Network Lane    
            SFP Detail Diagnostics Information (internal calibration)   
       ----------------------------------------------------------------------------      
                    Current                Alarms                   Warnings            
                    Measurement    High        Low        High         Low      
      ----------------------------------------------------------------------------      
      Temperature   24.65 C       75.00 C   -5.00 C      70.00 C         0.00 C    
      Voltage        3.40 V        3.63 V    2.97 V       3.46 V         3.09 V    
      Current           N/A           N/A       N/A          N/A            N/A    
      Tx Power          N/A           N/A       N/A          N/A            N/A      
      Rx Power          N/A           N/A       N/A          N/A            N/A    
      Transmit Fault Count = 0     
      ----------------------------------------------------------------------------     
      Note: ++  high-alarm; +  high-warning; --  low-alarm; -  low-warning     
     ...     
    

    Note: The property information for this example was added in Release 9.3(3).


    Verifying a DME Configuration
    The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

    MODN
    eqptFcotSensor sys/intf/phys-{[id]}/phys/fcot/lane-{laneId}-sensor-{sensorId}


    eqptFcotSensor Properties

    The following table contains information about the eqptFcotSensor properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

    Property NameData TypeDescriptionValues
    descriptionstring:Basic
    The transceiver sensor descriptionA sequence of characters
    dn
    reference:BinRef
    A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    highAlarmscalar:Float
    The transceiver sensor high alarm thresholdA floating number per IEEE-754 standard
    highWarningscalar:Float
    The transceiver sensor high warning thresholdA floating number per IEEE-754 standard
    laneIdscalar:Uint16
    The transceiver LANE identifierRANGE: [0, 65535]
    laneTypeeqpt:fcotDomLane
    (scalar:Enum8)
    The transceiver LANE typeSELECTION:
    0 - basic
    1 - extGlobal
    2 - extOptical
    lowAlarmscalar:Float
    The transceiver sensor low alarm thresholdA floating number per IEEE-754 standard
    lowWarningscalar:Float
    The transceiver sensor low warning thresholdA floating number per IEEE-754 standard
    sensorIdscalar:Uint16
    The transceiver sensor identifierRANGE: [0, 65535]
    unitstring:Basic
    The transceiver sensor unitA sequence of characters
    valuescalar:Float
    The transceiver sensor current valueA floating number per IEEE-754 standard


    Related Documentation

    For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

    http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

    See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

    https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

    For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

    https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html