ols-ucentral-schema/state/link-state.yml

type: object
description:
  A list of all LLDP peers that this logical interface is connected to.
properties:
  carrier:
    type: boolean
    description:
      The physical interfaces carrier state.
  speed:
    type: number
    description:
      The speed of the physical link.
  duplex:
    type: string
    description:
      The physical links duplex mode.
    enum:
    - full
    - half
  counters:
    $ref: "https://ucentral.io/state/v1/interface/counter/"
  delta_counters:
    $ref: "https://ucentral.io/state/v1/interface/counter/"
  poe:
    description:
      This section describes the ethernet poe-port link-state object (statistics + PD info).
      Present only in case if port has any Power sourcing capabilities.
    type: object
    properties:
      class-requested:
        description:
          Reports which PoE power class PD requested.
        type: number
      class-assigned:
        description:
          Reports which PoE power class PD has been assigned by the Power sourcing equipment.
        type: number
      output-power:
        description:
          Reports the power-value (in milliwatts, mW) poe-port's Powered Device is currently draining.
        type: number
      output-current:
        description:
          Reports the current value (in milliamps, mA) poe-port's Powered Device is currently draining.
        type: number
      output-voltage:
        description:
          Reports the operational voltage-level-value of poe-port's Power sourcing equipment (in Volts, V).
        type: string
        examples:
          - "54.14"
      temp:
        description:
          Reports the operational temperature of poe-port's Power sourcing equipment (in Celsius, C).
        type: string
        examples:
          - "22.5"
      status:
        description:
          Reports the operational status of poe-port's Power sourcing equipment.
          Searching option - the poe-port's PSE is trying to detect a Powered Device.
          Delivering option - the poe-port's PSE is delivering power to a Powered Device.
          Disabled option - the poe-port's PSE is either disabled or PoE power is enabled
          but the PoE module does not have enough power available to supply the port's power needs.
          Fault option - the poe-port's PSE detects a problem with the Powered Device.
          Other Fault option - the PSE has detected an internal fault that prevents it from supplying power on that port.
        type: string
        examples:
          - "DELIVERING_POWER"
          - "DISABLED"
      fault-status:
        description:
          Reports the fault status of poe-port's PSE (in case if any).
        type: string
        examples:
          - "NO_ERROR"
      counters:
        description:
          PoE-related descriptive statistics (counters).
        type: object
        properties:
          overload:
            description:
              Displays the total number of power overload occurrences.
              (Powered Device is consuming more power than the maximum limit of a port)
            type: number
          short:
            description:
              Displays the total number of power shortage occurrences.
            type: number
          power-denied:
            description:
              Displays the number of times that the powered device was denied power.
              (possible cause could be that Requested power exceeds PSE capability)
            type: number
          absent:
            description:
              Displays the number of times that the power was stopped to the powered device because the powered device
              was no longer detected.
            type: number
          invalid-signature:
            description:
              Displays the times that an invalid signature was received. Signatures are the means by which the powered device
              identifies itself to the PSE.
              Signatures are generated during powered device detection, classification, or maintenance.
            type: number
  ieee8021x:
    description:
      This section describes the per-port specific 802.1X (port access control) link-state object (authenticated clients).
      Present only in case if port has enabled EAP processing and has any authenticated clients.
    type: object
    properties:
      authenticated-clients:
        description:
          List of authenticated clients and (their) authentication data.
        type: array
        items:
          type: object
          properties:
            authenticated-method:
              description:
                Authentication method used by client for it's authentication.
              type: string
            mac-address:
              description:
                MAC address of authenticated client.
              type: string
              format: uc-mac
            session-time:
              description:
                Client session time.
              type: integer
            username:
              description:
                Client username.
              type: string
            vlan-type:
              description:
                Vlan type of authenticated client (Authorization status of the client).
              type: string
            vlan-id:
              description:
                Vlan type of authenticated client (Authorization status of the client).
              type: integer
              maximum: 4095
  transceiver-info:
    description:
      Object holds information about underlying SFP module currently inserted into port's cage.
      Some of information is read directly from module's EEPROM, while other data is measured in runtime by device's hardware (vcc for example).
    type: object
    properties:
      vendor-name:
        description:
          Vendor (name) identifier
        type: string
      form-factor:
        description:
          Form-factor of the module itself (For example - QSFP28, QSFP56-DD etc)
        type: string
      supported-link-modes:
        description:
          Reports supported link modes of inserted module
        type: array
        items:
          type: string
      part-number:
        description:
          Module's part number (vendor's specific)
        type: string
      serial-number:
        description:
          Serial number of connected module
        type: string
      revision:
        description:
          Module's HW revision (same part number can have multiple revisions)
        type: string
      temperature:
        description:
          Current module's temperature
        type: number
      tx-optical-power:
        description:
          Current module's transmit optical level (power)
        type: number
      rx-optical-power:
        description:
          Current module's receive optical level (power)
        type: number
      max-module-power:
        description:
          Max power (in Watts) module can drain.
        type: number
  loop-detect-protocol:
    description: Status and protocol information for loop detection or prevention mechanisms 
      active on this interface. Includes STP/xSTP/MSTP, Loopback Detection (LBD), etc.
    type: object
    properties:
      stp:
        description: Spanning Tree Protocol (IEEE 802.1D/RSTP/MSTP) state on the port.
        type: object
        properties:
          protocol:
            type: string
            description: Variant of STP running (e.g., STP, RSTP, MSTP, RPVST+).
            examples:
              - RSTP
              - MSTP
          state:
            type: string
            description: STP state of the port.
            enum:
              - disabled
              - blocking
              - listening
              - learning
              - forwarding
          role:
            type: string
            description: Role of the port in STP topology.
            enum:
              - root
              - designated
              - alternate
              - backup
              - disabled
          bridge-id:
            type: string
            description: STP Bridge ID
          root-bridge-id:
            type: string
            description: STP Root Bridge ID for the instance.
          oper-edge-port:
            type: boolean
            description: Whether the port is operating as an edge port (no BPDU expected).
          cost:
            type: integer
            description: Operational path cost of the port.
          designated-cost:
            type: integer
            description: Cost advertised by the designated port.
          transitions:
            type: integer
            description: Number of STP state transitions (forwarding/discarding) on this port.
          bpdu-guard:
            type: string
            description: Runtime status of BPDU Guard on the port, when it detects any issue. 
              - `errdisabled`- Port is shutdown due to BPDU violation.
              - `recovering`- Temporarily disabled and in auto-recovery interval.
            enum:
              - errdisabled
              - recovering
      lbd:
        description: Loopback Detection (LBD) status on this port.
        type: object
        properties:
          enabled:
            type: boolean
            description: Whether LBD is enabled on this port.
          state:
            type: string
            description: Current loop detection status.
            enum:
              - no_loop
              - loop_detected
              - disabled
          action:
            type: string
            description: Action taken when loop is detected (e.g., block, shutdown).
            enum:
              - none
              - block
              - shutdown
  storm-status:
    description: Runtime status of Storm Control feature on the port for each storm type.
    type: object
    properties:
      broadcast:
        type: boolean
        description: Runtime status of Broadcast Storm Control on the port. Return `true`if Storm condition is detected.
      multicast:
        type: boolean
        description: Runtime status of Multicast Storm Control on the port. Return `true`if Storm condition is detected.
      unknown-unicast:
        type: boolean
        description: Runtime status of Unknown Unicast Storm Control on the port. Return `true`if Storm condition is detected.