api_commands.yaml

commands:
  show processes top once:
    type: flat
    metrics:
      - name: cpuInfo.%Cpu(s).idle
      - name: cpuInfo.%Cpu(s).stolen
      - name: cpuInfo.%Cpu(s).user
      - name: cpuInfo.%Cpu(s).swIrq
      - name: cpuInfo.%Cpu(s).ioWait
      - name: cpuInfo.%Cpu(s).system
      - name: cpuInfo.%Cpu(s).hwIrq
      - name: cpuInfo.%Cpu(s).nice
  show version:
    type: flat
    metrics:
      - name: memFree
      - name: memTotal
      - name: uptime
  show interfaces:
    type: multiple
    lookup_keys: interfaces
    metrics:
      - name: bandwidth
      - name: interfaceCounters.inBroadcastPkts
      - name: interfaceCounters.inDiscards
      - name: interfaceCounters.inMulticastPkts
      - name: interfaceCounters.inOctets
      - name: interfaceCounters.inTotalPkts
      - name: interfaceCounters.inUcastPkts
      - name: interfaceCounters.inputErrorsDetail.alignmentErrors
      - name: interfaceCounters.inputErrorsDetail.fcsErrors
      - name: interfaceCounters.inputErrorsDetail.giantFrames
      - name: interfaceCounters.inputErrorsDetail.runtFrames
      - name: interfaceCounters.inputErrorsDetail.rxPause
      - name: interfaceCounters.inputErrorsDetail.symbolErrors
      - name: interfaceCounters.linkStatusChanges
      - name: interfaceCounters.outBroadcastPkts
      - name: interfaceCounters.outDiscards
      - name: interfaceCounters.outMulticastPkts
      - name: interfaceCounters.outOctets
      - name: interfaceCounters.outUcastPkts
      - name: interfaceCounters.outputErrorsDetail.collisions
      - name: interfaceCounters.outputErrorsDetail.deferredTransmissions
      - name: interfaceCounters.outputErrorsDetail.lateCollisions
      - name: interfaceCounters.outputErrorsDetail.txPause
      - name: interfaceCounters.totalInErrors
      - name: interfaceCounters.totalOutErrors
      - name: interfaceStatus
        type: mapping
        mapping:
          uninitialized: 0
          maint-down: 1
          admin: 2
          unknown: 3
          notconnect: 4
          disabled: 5
          inactive: 6
          connected: 7
          errdisabled: 8
      - name: lineProtocolStatus
        type: mapping
        mapping:
          dormant: 0
          lowerLayerDown: 1
          unknown: 2
          testing: 3
          up: 4
          down: 5
          notPresent: 6
      - name: mtu
    labels:
      - name: name
        prom_name: interface_name
      - name: description
  show ip route vrf all summary:
    type: multiple
    lookup_keys: vrfs
    metrics:
      - name: totalRoutes
      - name: ospfv3Counts.ospfv3Total
      - name: staticNexthopGroup
      - name: bgpCounts.bgpTotal
      - name: attached
      - name: gribi
      - name: staticNonPersistent
      - name: staticPersistent
      - name: vcs
      - name: connected
      - name: rip
      - name: isisCounts.isisTotal
      - name: aggregate
      - name: dynamicPolicy
      - name: internal
      - name: ospfCounts.ospfTotal
      - name: maskLen
        type: buckets
        bucket_name: prefix_length
    labels:
      - name: vrfs
        prom_name: vrf
        special: metadata
  show ip bgp summary:
    type: multiple
    lookup_keys: ['vrfs', 'peers']
    metrics:
      - name: prefixReceived
      - name: msgSent
      - name: inMsgQueue
      - name: msgReceived
      - name: prefixAccepted
      - name: peerState
        type: mapping
        mapping:
          Established: 0
          OpenConfirm: 1
          NotNegotiated: 2
          OpenSent: 3
          Idle: 4
          Connect: 5
          Active: 6
      - name: outMsgQueue
    labels:
      - name: version
      - name: asn
      - name: peers
        prom_name: peer
        special: metadata
      - name: vrfs
        prom_name: vrf
        special: metadata
  show hardware capacity:
    type: list
    lookup_key: tables
    metrics:
      - name: used
      - name: maxLimit
      - name: highWatermark
    labels:
      - name: table
      - name: feature
      - name: chip