platform

platform
+  chassis
   -  clei-code string
   -  failure-reason string
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  hw-mac-address string
   -  last-boot-type string
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  manufactured-date string
   -  oper-state keyword
   -  part-number string
   +  power
      -  control
         -  peak number
         -  required number
         -  used number
      -  fabric
         -  peak number
         -  required number
         -  used number
      -  fan-tray
         -  peak number
         -  required number
         -  used number
      -  linecard
         -  peak number
         -  required number
         -  used number
      -  total
         -  capacity number
         -  peak number
         -  required number
         -  used number
   -  rebooting-at string
   -  removable boolean
   +  secondary-mac-address string
   -  serial-number string
   -  slots number
   -  type string
+  control slot string 
   -  cgroup name string 
      -  cpuacct-statistics
         -  system number
         -  user number
      -  memory-statistics
         -  anon number
         -  anon-thp number
         -  current number
         -  current-swap number
         -  file number
         -  file-dirty number
         -  file-writeback number
         -  kernel-stack number
         -  memory-events
            -  high number
            -  low number
            -  max number
            -  oom number
            -  oom-kill number
         -  slab number
         -  sock number
   -  clei-code string
   -  cpu index (keyword | number) 
      -  architecture keyword
      -  hardware-interrupt
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  idle
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  iowait
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  nice
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  software-interrupt
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  speed decimal-number
      -  system
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  total
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
      -  type string
      -  user
         -  average-1 number
         -  average-15 number
         -  average-5 number
         -  instant number
   -  disk name string 
      -  model-number string
      -  partition name string 
         -  free number
         -  mount-point string
         -  mount-status keyword
         -  percent-used number
         -  size number
         -  used number
         -  uuid string
      -  serial-number string
      -  size number
      -  statistics
         -  read-per-second decimal-number
         -  transfers-per-second decimal-number
         -  utilization number
         -  written-per-second decimal-number
      -  type keyword
   -  failure-reason string
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  last-switchover-reason
      -  details string
      -  trigger identityref
   -  locator-state keyword
   -  manufactured-date string
   -  memory
      -  free number
      -  physical number
      -  reserved number
      -  utilization number
   -  oper-state keyword
   -  part-number string
   -  power
      -  required number
      -  used number
   -  process pid number 
      -  args string
      -  cpu-utilization number
      -  memory-usage number
      -  memory-utilization number
      -  name string
      -  start-time string
   -  rebooting-at string
   -  removable boolean
   -  role keyword
   -  serial-number string
   -  software-version string
   -  temperature
      -  alarm-status boolean
      -  instant number
      -  margin number
   -  type string
+  fabric slot number 
   +  admin-state keyword
   -  clei-code string
   -  failure-reason string
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  locator-state keyword
   -  manufactured-date string
   -  oper-state keyword
   -  part-number string
   -  power
      -  required number
      -  used number
   -  rebooting-at string
   -  removable boolean
   -  serial-number string
   -  temperature
      -  alarm-status boolean
      -  instant number
      -  margin number
   -  type string
-  fan-tray id number 
   -  clei-code string
   -  failure-reason string
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  locator-state keyword
   -  manufactured-date string
   -  oper-reason keyword
   -  oper-state keyword
   -  part-number string
   -  power
      -  required number
      -  used number
   -  removable boolean
   -  serial-number string
   -  speed number
   -  speed-rpm number
   -  type string
+  linecard slot number 
   +  admin-state keyword
   -  clei-code string
   -  failure-reason string
   +  forwarding-complex name keyword 
      -  acl
         -  resource name identityref 
            -  free number
            -  used number
      +  buffer-memory
         -  dram
            -  used number
         -  free number
         -  reserved number
         -  sram
            -  free number
            -  used number
         -  used number
      -  datapath
         -  asic
            -  resource name identityref 
               -  free-entries number
               -  used-entries number
               -  used-percent number
         -  xdp
            -  resource name identityref 
               -  free-entries number
               -  used-entries number
               -  used-percent number
      +  fabric
         -  availability number
         -  utilization-egress number
         -  utilization-ingress number
      -  fib-table
         -  next-hop-group index number 
            -  backup-active boolean
            -  backup-next-hop-group reference
            -  next-hop id number 
               -  next-hop number
               -  oper-state keyword
            -  oper-state keyword
      -  last-booted string
      -  last-booted-reason identityref
      -  last-change string
      -  mtu
         -  resource name identityref 
            -  free number
            -  used number
      -  oper-state keyword
      +  p4rt
         +  id number
      -  part-number string
      +  pipeline index (number | keyword) 
         -  datapath
            -  xdp
               -  resource name identityref 
                  -  free-entries number
                  -  used-entries number
                  -  used-percent number
         -  pipeline-counters
            -  host-interface-block
               -  packet-extraction
                  -  extracted-octets number
                  -  extracted-packets number
                  -  extraction-reason reason identityref 
                     -  extracted-octets number
                     -  extracted-packets number
      -  qos
         -  resource name identityref 
            -  free number
            -  used number
      -  removable boolean
      -  tcam
         -  resource name identityref 
            -  free-dynamic number
            -  free-static number
            -  programmed number
            -  reserved number
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  locator-state keyword
   -  manufactured-date string
   -  oper-state keyword
   -  part-number string
   -  power
      -  required number
      -  used number
   -  rebooting-at string
   -  removable boolean
   -  serial-number string
   -  software-version string
   -  temperature
      -  alarm-status boolean
      -  instant number
      -  margin number
   -  type string
-  power-supply id number 
   -  capacity number
   -  clei-code string
   -  failure-reason string
   -  fan
      -  speed number
      -  speed-rpm number
   -  feed id number 
      -  current decimal-number
      -  voltage decimal-number
   -  healthz
      -  last-unhealthy string
      -  status keyword
      -  unhealthy-count number
   -  input
      -  current decimal-number
      -  power decimal-number
      -  voltage decimal-number
   -  last-booted string
   -  last-booted-reason identityref
   -  last-change string
   -  manufactured-date string
   -  oper-reason keyword
   -  oper-state keyword
   -  output
      -  current decimal-number
      -  power decimal-number
      -  voltage decimal-number
   -  part-number string
   -  removable boolean
   -  serial-number string
   -  temperature
      -  alarm-status boolean
      -  instant number
   -  type string
+  redundancy
   -  active-module keyword
   -  failover-time string
   +  synchronization
      -  last-synchronization string
      +  overlay
         -  last-synchronization string
         -  next-synchronization string
         +  synchronization-frequency number
      -  state keyword
+  resource-management
   +  tcam
   +  unified-forwarding-resources
      -  allocated-extra-ip-host-entries number
      -  allocated-extra-mac-entries number
      +  alpm keyword
      +  ipv6-128bit-lpm-entries number
      +  requested-extra-ip-host-entries number
      -  xdp-restart-required boolean
+  resource-monitoring
   +  acl
      +  resource name identityref 
         +  falling-threshold-log number
         +  rising-threshold-log number
   +  datapath
      +  asic
         +  resource name identityref 
            +  falling-threshold-log number
            +  rising-threshold-log number
      +  xdp
         +  resource name identityref 
            +  falling-threshold-log number
            +  rising-threshold-log number
   +  mtu
      +  resource name identityref 
         +  falling-threshold-log number
         +  rising-threshold-log number
   +  qos
      +  resource name identityref 
         +  falling-threshold-log number
         +  rising-threshold-log number
   +  tcam
      +  resource name identityref 
         +  falling-threshold-log number
         +  rising-threshold-log number

platform Descriptions

platform

Description Enclosing container for platform components
Contextplatform
Treeplatform
ConfigurableTrue
PlatformsSupported on all platforms

chassis

Description Top-level container for chassis configuration and state
Contextplatform chassis
Treechassis
ConfigurableTrue
PlatformsSupported on all platforms

clei-code string

Description The Common Language Identification Code for this component
Contextplatform chassis clei-code string
Treeclei-code
ConfigurableFalse
PlatformsSupported on all platforms

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform chassis failure-reason string
Treefailure-reason
ConfigurableFalse
PlatformsSupported on all platforms

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform chassis healthz
Treehealthz
ConfigurableFalse
PlatformsSupported on all platforms
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform chassis healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform chassis healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
PlatformsSupported on all platforms
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform chassis healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
PlatformsSupported on all platforms

hw-mac-address string

Description

The chassis MAC address

Read from hardware, or derived from the systems UUID

Contextplatform chassis hw-mac-address string
Treehw-mac-address
ConfigurableFalse
PlatformsSupported on all platforms

last-boot-type string

Description

The type of boot the chassis initialized from

This field indicates what type of reboot occurred, whether it be warm, normal, or otherwise.

Contextplatform chassis last-boot-type string
Treelast-boot-type
ConfigurableFalse
PlatformsSupported on all platforms

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform chassis last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform chassis last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms

last-change string

Description The date and time this component last changed state
Contextplatform chassis last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

oper-state keyword

Description The operational state of this component
Contextplatform chassis oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms

power

Description Top-level container for chassis-wide power state
Contextplatform chassis power
Treepower
ConfigurableTrue
PlatformsSupported on all platforms
control
Description Top-level container for power usage of control modules
Contextplatform chassis power control
Treecontrol
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
peak number
Description Peak power used
Context platform chassis power control peak number
Treepeak
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description Power required to power on all present admin enabled components as part of power management
Contextplatform chassis power control required number
Treerequired
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
fabric
Description Top-level container for power usage of fabric modules
Contextplatform chassis power fabric
Treefabric
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
peak number
Description Peak power used
Context platform chassis power fabric peak number
Treepeak
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description Power required to power on all present admin enabled components as part of power management
Contextplatform chassis power fabric required number
Treerequired
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
used number
Description Used power
Context platform chassis power fabric used number
Treeused
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
fan-tray
Description Top-level container for power usage of fan-trays
Contextplatform chassis power fan-tray
Treefan-tray
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description Power required to power on all present admin enabled components as part of power management
Contextplatform chassis power fan-tray required number
Treerequired
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
linecard
Description Top-level container for power usage of linecard modules
Contextplatform chassis power linecard
Treelinecard
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description Power required to power on all present admin enabled components as part of power management
Contextplatform chassis power linecard required number
Treerequired
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
total
Description Top-level container for total power usage and capacity
Contextplatform chassis power total
Treetotal
ConfigurableFalse
PlatformsSupported on all platforms
required number
Description Power required to power on all present admin enabled components as part of power management
Contextplatform chassis power total required number
Treerequired
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

rebooting-at string

Description

Indicates the date and time this component will reboot

If empty, no delayed reboots are queued for this component.

A non empty value implies that a delayed reboot operation has been triggered for this component, which can be aborted using 'tools platform <component> reboot cancel'.

Contextplatform chassis rebooting-at string
Treerebooting-at
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

removable boolean

Description Details if this component can be removed from the system
Contextplatform chassis removable boolean
Treeremovable
ConfigurableFalse
PlatformsSupported on all platforms

secondary-mac-address string

Description

MAC address programmed as a secondary terminating MAC address on every IP interface, across all network instances

If an IP packet is received on a routed subinterface and it arrives with a DMAC equal to the secondary-mac-address then it is terminated and forwarded exactly the same way it would be forwarded if it had arrived on this subinterface with a DMAC equal to the subinterface MAC address.

Contextplatform chassis secondary-mac-address string
Treesecondary-mac-address
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

slots number

Description The number of line card slots supported by the chassis
Contextplatform chassis slots number
Treeslots
ConfigurableFalse
PlatformsSupported on all platforms

type string

Description The chassis type
Context platform chassis type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms

control slot string

Description Top-level container for control module configuration and state
Contextplatform control slot string
Treecontrol
ConfigurableTrue
PlatformsSupported on all platforms

slot string

Description

Slot identifier for the control module

This is set to 'A' for systems without removable control modules.

Contextplatform control slot string
ConfigurableTrue
PlatformsSupported on all platforms

cgroup name string

Description List of cgroups present in the system
Contextplatform control slot string cgroup name string
Treecgroup
ConfigurableFalse
PlatformsSupported on all platforms
name string
Description Name of the cgroup, as defined by its directory location in the filesystem
Contextplatform control slot string cgroup name string
ConfigurableFalse
PlatformsSupported on all platforms
cpuacct-statistics
Description Top-level container for cgroup cpuacct statistics
Contextplatform control slot string cgroup name string cpuacct-statistics
Treecpuacct-statistics
ConfigurableFalse
PlatformsSupported on all platforms
memory-statistics
Description Top-level container for cgroup memory statistics
Contextplatform control slot string cgroup name string memory-statistics
Treememory-statistics
ConfigurableFalse
PlatformsSupported on all platforms
anon number
Description Amount of memory used in anonymous mappings such as brk(), sbrk(), and mmap(MAP_ANONYMOUS)
Contextplatform control slot string cgroup name string memory-statistics anon number
Treeanon
Unitsbytes
ConfigurableFalse
PlatformsSupported on all platforms
current number
Description The total amount of memory currently being used by the cgroup and its descendants. Read from memory.current
Contextplatform control slot string cgroup name string memory-statistics current number
Treecurrent
Unitsbytes
ConfigurableFalse
PlatformsSupported on all platforms
memory-events
Description Top-level container for cgroup memory events
Contextplatform control slot string cgroup name string memory-statistics memory-events
Treememory-events
ConfigurableFalse
PlatformsSupported on all platforms
high number
Description The number of times processes of the cgroup are throttled and routed to perform direct memory reclaim because the high memory boundary was exceeded.
Contextplatform control slot string cgroup name string memory-statistics memory-events high number
Treehigh
ConfigurableFalse
PlatformsSupported on all platforms

clei-code string

Description The Common Language Identification Code for this component
Contextplatform control slot string clei-code string
Treeclei-code
ConfigurableFalse
PlatformsSupported on all platforms

cpu index (keyword | number)

Description List of all CPUs in the system
Context platform control slot string cpu index (keyword | number)
Treecpu
ConfigurableFalse
PlatformsSupported on all platforms
index (keyword | number)
Description

CPU index for each processor core on the system

On a single-core system, the index should be zero. The 'all' index signifies an aggregation of the CPU utilization statistics over all cores in the system.

Contextplatform control slot string cpu index (keyword | number)
Options

  • all

    Index value indicating all CPUs in the system

ConfigurableFalse
PlatformsSupported on all platforms
hardware-interrupt
Description Time spent servicing hardware interrupts
Contextplatform control slot string cpu index (keyword | number) hardware-interrupt
Treehardware-interrupt
ConfigurableFalse
PlatformsSupported on all platforms
idle
Description Time spent idle
Context platform control slot string cpu index (keyword | number) idle
Treeidle
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) idle average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) idle average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) idle average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
instant number
Description The instantaneous percentage value
Context platform control slot string cpu index (keyword | number) idle instant number
Treeinstant
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
iowait
Description Time spent idle, waiting for an outstanding disk I/O request
Contextplatform control slot string cpu index (keyword | number) iowait
Treeiowait
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) iowait average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) iowait average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) iowait average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
nice
Description Time spent running low-priority (niced) user processes
Contextplatform control slot string cpu index (keyword | number) nice
Treenice
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) nice average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) nice average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) nice average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
instant number
Description The instantaneous percentage value
Context platform control slot string cpu index (keyword | number) nice instant number
Treeinstant
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
software-interrupt
Description Time spent servicing software interrupts
Contextplatform control slot string cpu index (keyword | number) software-interrupt
Treesoftware-interrupt
ConfigurableFalse
PlatformsSupported on all platforms
speed decimal-number
Description Capable speed of the CPU
Context platform control slot string cpu index (keyword | number) speed decimal-number
Treespeed
Unitsgigahertz
ConfigurableFalse
PlatformsSupported on all platforms
system
Description

Time spent executing at the system level

This can otherwise be known as kernel time, and does not include time spent servicing hardware and software interrupts.

Contextplatform control slot string cpu index (keyword | number) system
Treesystem
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) system average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) system average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) system average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
total
Description Total CPU utilization
Context platform control slot string cpu index (keyword | number) total
Treetotal
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) total average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) total average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) total average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
type string
Description Model name of the CPU
Context platform control slot string cpu index (keyword | number) type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms
user
Description

Time spent executing at the user level

This can otherwise be known as application or user space time.

Contextplatform control slot string cpu index (keyword | number) user
Treeuser
ConfigurableFalse
PlatformsSupported on all platforms
average-1 number
Description The arithmetic mean value of this statistic over the last minute
Contextplatform control slot string cpu index (keyword | number) user average-1 number
Treeaverage-1
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-15 number
Description The arithmetic mean value of this statistic over the last fifteen minutes
Contextplatform control slot string cpu index (keyword | number) user average-15 number
Treeaverage-15
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
average-5 number
Description The arithmetic mean value of this statistic over the last five minutes
Contextplatform control slot string cpu index (keyword | number) user average-5 number
Treeaverage-5
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms
instant number
Description The instantaneous percentage value
Context platform control slot string cpu index (keyword | number) user instant number
Treeinstant
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms

disk name string

Description List of disks present in the system
Context platform control slot string disk name string
Treedisk
ConfigurableFalse
PlatformsSupported on all platforms
name string
Description Name of the disk, as defined by its physical location in the system
Contextplatform control slot string disk name string
ConfigurableFalse
PlatformsSupported on all platforms
partition name string
Description List of partitions available on this disk
Contextplatform control slot string disk name string partition name string
Treepartition
ConfigurableFalse
PlatformsSupported on all platforms
mount-status keyword
Description Current mount status of this partition
Contextplatform control slot string disk name string partition name string mount-status keyword
Treemount-status
Options

  • ro

    Partition is currently mounted read-only

  • rw

    Partition is currently mounted read-write

ConfigurableFalse
PlatformsSupported on all platforms
size number
Description Total size of the disk
Context platform control slot string disk name string size number
Treesize
ConfigurableFalse
PlatformsSupported on all platforms
statistics
Description Top-level container for disk statistics
Contextplatform control slot string disk name string statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
transfers-per-second decimal-number
Description Indicates the number of transfers per second that were issued to the device A transfer is an I/O request to the device. Multiple logical requests can be combined into a single I/O request to the device. A transfer is of indeterminate size.
Contextplatform control slot string disk name string statistics transfers-per-second decimal-number
Treetransfers-per-second
ConfigurableFalse
PlatformsSupported on all platforms
type keyword
Description Type of disk
Context platform control slot string disk name string type keyword
Treetype
Options

  • compactflash

  • ssd

  • hdd

  • usb

ConfigurableFalse
PlatformsSupported on all platforms

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform control slot string failure-reason string
Treefailure-reason
ConfigurableFalse
PlatformsSupported on all platforms

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform control slot string healthz
Treehealthz
ConfigurableFalse
PlatformsSupported on all platforms
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform control slot string healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform control slot string healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
PlatformsSupported on all platforms
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform control slot string healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
PlatformsSupported on all platforms

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform control slot string last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform control slot string last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms

last-change string

Description The date and time this component last changed state
Contextplatform control slot string last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-switchover-reason

Description State information relating to the last control module switchover
Contextplatform control slot string last-switchover-reason
Treelast-switchover-reason
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
details string
Description

Any additional details relating to the last switchover

This field is not populated if the system has not performed a switchover since initial startup.

Contextplatform control slot string last-switchover-reason details string
Treedetails
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
trigger identityref
Description

Indicates the trigger of the last switchover

This field is not populated if the system has not performed a switchover since initial startup.

Contextplatform control slot string last-switchover-reason trigger identityref
Treetrigger
Options

  • user-initiated

    A user initiated the switchover directly via the tools schema

  • control-reboot

    A user initiated the switchover indirectly via rebooting the active control module

  • control-failure

    The system has forced a switchover due to a failure on the active control module

  • linecard-connectivity

    The system has forced a switchover due to a loss of connectivity between the active control module and one or more linecards

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

locator-state keyword

Description Details if the locator LED is active on this component
Contextplatform control slot string locator-state keyword
Treelocator-state
Defaultinactive
Options

  • active

    Locator LED is currently active

  • inactive

    Locator LED is currently inactive

ConfigurableFalse
PlatformsSupported on all platforms

memory

Description Top-level container for system memory state
Contextplatform control slot string memory
Treememory
ConfigurableFalse
PlatformsSupported on all platforms
free number
Description Memory available for system use
Context platform control slot string memory free number
Treefree
Unitsbytes
ConfigurableFalse
PlatformsSupported on all platforms
physical number
Description Total physical memory available on this component
Contextplatform control slot string memory physical number
Treephysical
Unitsbytes
ConfigurableFalse
PlatformsSupported on all platforms

oper-state keyword

Description The operational state of this component
Contextplatform control slot string oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms

power

Description State related to power consumption and allocation for this component
Contextplatform control slot string power
Treepower
ConfigurableFalse
PlatformsSupported on all platforms
required number
Description The power budget required to enable this component
Contextplatform control slot string power required number
Treerequired
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
used number
Description The power in use by this component
Context platform control slot string power used number
Treeused
Unitswatts
ConfigurableFalse
PlatformsSupported on all platforms

process pid number

Description List of system processes
Context platform control slot string process pid number
Treeprocess
ConfigurableFalse
PlatformsSupported on all platforms
pid number
Description The process ID
Context platform control slot string process pid number
ConfigurableFalse
PlatformsSupported on all platforms
args string
Description Current process command line arguments Arguments with a parameter (e.g., --option 10 or -option=10) should be represented as a single element of the list with the argument name and parameter together. Flag arguments, i.e., those without a parameter should also be in their own list element.
Contextplatform control slot string process pid number args string
Treeargs
ConfigurableFalse
PlatformsSupported on all platforms

rebooting-at string

Description

Indicates the date and time this component will reboot

If empty, no delayed reboots are queued for this component.

A non empty value implies that a delayed reboot operation has been triggered for this component, which can be aborted using 'tools platform <component> reboot cancel'.

Contextplatform control slot string rebooting-at string
Treerebooting-at
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

removable boolean

Description Details if this component can be removed from the system
Contextplatform control slot string removable boolean
Treeremovable
ConfigurableFalse
PlatformsSupported on all platforms

role keyword

Description

Control module role, detailing active or standby state

This field is not present on systems without removable control modules.

Contextplatform control slot string role keyword
Treerole
Options

  • active

  • standby

Configurable False
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

software-version string

Description

Image version version running on this component

This version is the squashfs version, and may not represent the current per-application versions if versions have been modified after the system has been installed.

Contextplatform control slot string software-version string
Treesoftware-version
ConfigurableFalse
PlatformsSupported on all platforms

temperature

Description State related to temperature for this component
Contextplatform control slot string temperature
Treetemperature
ConfigurableFalse
PlatformsSupported on all platforms
alarm-status boolean
Description

Indicates if a temperature sensor of this component is currently in an alarm state

An alarm state is triggered if the margin field is <=2 degrees, indicating that a thermal protection shut down is imminent unless adequate system cooling is provided to bring the temperature sensor back into safe operating ranges.

Contextplatform control slot string temperature alarm-status boolean
Treealarm-status
ConfigurableFalse
PlatformsSupported on all platforms
instant number
Description

Represents the highest temperature of any sensor on this component

Note that as multiple sensors may feed in, that this field and the margin field may be referencing different sensors.

Contextplatform control slot string temperature instant number
Treeinstant
ConfigurableFalse
PlatformsSupported on all platforms
margin number
Description

Indicates the lowest alarm margin of any sensor on this component

The margin is the delta between the current sensor temperature and the thermal protection threshold for that sensor. Note that as multiple sensors may feed in, that this field and the instant field may be referencing different sensors.

Contextplatform control slot string temperature margin number
Treemargin
ConfigurableFalse
PlatformsSupported on all platforms

type string

Description Control module type, as translated from the components EEPROM
Contextplatform control slot string type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms

fabric slot number

Description Top-level container for fabric configuration and state
Contextplatform fabric slot number
Treefabric
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

slot number

Description Numeric identifier for the fabric module
Contextplatform fabric slot number
Range1 to 255
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

admin-state keyword

Description The administrative state of this component
Contextplatform fabric slot number admin-state keyword
Treeadmin-state
Defaultenable
Options

  • enable

  • disable

Configurable True
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

clei-code string

Description The Common Language Identification Code for this component
Contextplatform fabric slot number clei-code string
Treeclei-code
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform fabric slot number failure-reason string
Treefailure-reason
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform fabric slot number healthz
Treehealthz
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform fabric slot number healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform fabric slot number healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform fabric slot number healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform fabric slot number last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform fabric slot number last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

last-change string

Description The date and time this component last changed state
Contextplatform fabric slot number last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

locator-state keyword

Description Details if the locator LED is active on this component
Contextplatform fabric slot number locator-state keyword
Treelocator-state
Defaultinactive
Options

  • active

    Locator LED is currently active

  • inactive

    Locator LED is currently inactive

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

manufactured-date string

Description The date this component was manufactured
Contextplatform fabric slot number manufactured-date string
Treemanufactured-date
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

oper-state keyword

Description The operational state of this component
Contextplatform fabric slot number oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

part-number string

Description Part number for this component
Context platform fabric slot number part-number string
Treepart-number
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

power

Description State related to power consumption and allocation for this component
Contextplatform fabric slot number power
Treepower
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description The power budget required to enable this component
Contextplatform fabric slot number power required number
Treerequired
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
used number
Description The power in use by this component
Context platform fabric slot number power used number
Treeused
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

rebooting-at string

Description

Indicates the date and time this component will reboot

If empty, no delayed reboots are queued for this component.

A non empty value implies that a delayed reboot operation has been triggered for this component, which can be aborted using 'tools platform <component> reboot cancel'.

Contextplatform fabric slot number rebooting-at string
Treerebooting-at
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

removable boolean

Description Details if this component can be removed from the system
Contextplatform fabric slot number removable boolean
Treeremovable
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

serial-number string

Description The serial number for this component
Context platform fabric slot number serial-number string
Treeserial-number
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

temperature

Description State related to temperature for this component
Contextplatform fabric slot number temperature
Treetemperature
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
alarm-status boolean
Description

Indicates if a temperature sensor of this component is currently in an alarm state

An alarm state is triggered if the margin field is <=2 degrees, indicating that a thermal protection shut down is imminent unless adequate system cooling is provided to bring the temperature sensor back into safe operating ranges.

Contextplatform fabric slot number temperature alarm-status boolean
Treealarm-status
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
instant number
Description

Represents the highest temperature of any sensor on this component

Note that as multiple sensors may feed in, that this field and the margin field may be referencing different sensors.

Contextplatform fabric slot number temperature instant number
Treeinstant
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
margin number
Description

Indicates the lowest alarm margin of any sensor on this component

The margin is the delta between the current sensor temperature and the thermal protection threshold for that sensor. Note that as multiple sensors may feed in, that this field and the instant field may be referencing different sensors.

Contextplatform fabric slot number temperature margin number
Treemargin
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

type string

Description Fabric module type, as translated from the components EEPROM
Contextplatform fabric slot number type string
Treetype
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

fan-tray id number

Description Top-level container for fan module configuration and state
Contextplatform fan-tray id number
Treefan-tray
ConfigurableFalse
PlatformsSupported on all platforms

id number

Description Numeric identifier for the fan tray
Context platform fan-tray id number
Range1 to 255
ConfigurableFalse
PlatformsSupported on all platforms

clei-code string

Description The Common Language Identification Code for this component
Contextplatform fan-tray id number clei-code string
Treeclei-code
ConfigurableFalse
PlatformsSupported on all platforms

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform fan-tray id number failure-reason string
Treefailure-reason
ConfigurableFalse
PlatformsSupported on all platforms

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform fan-tray id number healthz
Treehealthz
ConfigurableFalse
PlatformsSupported on all platforms
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform fan-tray id number healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform fan-tray id number healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
PlatformsSupported on all platforms
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform fan-tray id number healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
PlatformsSupported on all platforms

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform fan-tray id number last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform fan-tray id number last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms

last-change string

Description The date and time this component last changed state
Contextplatform fan-tray id number last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

locator-state keyword

Description Details if the locator LED is active on this component
Contextplatform fan-tray id number locator-state keyword
Treelocator-state
Defaultinactive
Options

  • active

    Locator LED is currently active

  • inactive

    Locator LED is currently inactive

ConfigurableFalse
PlatformsSupported on all platforms

oper-reason keyword

Description Indicates the reason for the current state of this fan tray
Contextplatform fan-tray id number oper-reason keyword
Treeoper-reason
Options

  • fault

    Hardware fault detected

  • eeprom-invalid

    EEPROM of this fan tray is either invalid or corrupt

  • airflow-mismatch

    The detected airflow of this fan tray does not match the system-calculated airflow direction

    The logic for determining the system-calculated direction is: - Majority wins between present fan trays - In the case where there are equal F2B or B2F fan-trays, PSUs are used as a tie break (PSUs only are counted in the event a tie breaker is needed) - F2B wins if no tie break can be used

ConfigurableFalse
PlatformsSupported on all platforms

oper-state keyword

Description The operational state of this component
Contextplatform fan-tray id number oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms

power

Description State related to power consumption and allocation for this component
Contextplatform fan-tray id number power
Treepower
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description The power budget required to enable this component
Contextplatform fan-tray id number power required number
Treerequired
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
used number
Description The power in use by this component
Context platform fan-tray id number power used number
Treeused
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

removable boolean

Description Details if this component can be removed from the system
Contextplatform fan-tray id number removable boolean
Treeremovable
ConfigurableFalse
PlatformsSupported on all platforms

speed number

Description The current speed of the fan tray
Context platform fan-tray id number speed number
Treespeed
Range0 to 100
ConfigurableFalse
PlatformsSupported on all platforms

speed-rpm number

Description The current RPM of the fan tray
Context platform fan-tray id number speed-rpm number
Treespeed-rpm
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

type string

Description Fan tray type, as translated from the components EEPROM
Contextplatform fan-tray id number type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms

linecard slot number

Description Top-level container for linecard configuration and state
Contextplatform linecard slot number
Treelinecard
ConfigurableTrue
PlatformsSupported on all platforms

slot number

Description Numeric identifier for the linecard
Context platform linecard slot number
Range1 to 8
ConfigurableTrue
PlatformsSupported on all platforms

admin-state keyword

Description The administrative state of this component
Contextplatform linecard slot number admin-state keyword
Treeadmin-state
Defaultenable
Options

  • enable

  • disable

Configurable True
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

clei-code string

Description The Common Language Identification Code for this component
Contextplatform linecard slot number clei-code string
Treeclei-code
ConfigurableFalse
PlatformsSupported on all platforms

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform linecard slot number failure-reason string
Treefailure-reason
ConfigurableFalse
PlatformsSupported on all platforms

forwarding-complex name keyword

Description List of forwarding complexes on the linecard
Contextplatform linecard slot number forwarding-complex name keyword
Treeforwarding-complex
ConfigurableTrue
PlatformsSupported on all platforms
acl
Description Enter the acl context
Context platform linecard slot number forwarding-complex name keyword acl
Treeacl
ConfigurableFalse
PlatformsSupported on all platforms
resource name identityref
Description Enter the resource list instance
Context platform linecard slot number forwarding-complex name keyword acl resource name identityref
Treeresource
ConfigurableFalse
PlatformsSupported on all platforms
name identityref
Description The name of the ACL resource
Context platform linecard slot number forwarding-complex name keyword acl resource name identityref
Options

  • input-ipv4-filter-instances

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on the forwarding complex. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every subinterface using the IPv4 filter.

  • input-ipv4-qos-multifield-instances

    This resource is used every time an IPv4 multifield classifier policy is applied to ingress traffic on a subinterface.

  • input-ipv4-filter-instances-routed

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on routed subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every routed subinterface using the IPv4 filter.

  • input-ipv4-filter-instances-bridged

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on bridged subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every bridged subinterface using the IPv4 filter.

  • input-ipv6-filter-instances

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on the forwarding complex. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every subinterface using the IPv6 filter.

  • input-ipv6-qos-multifield-instances

    This resource is used every time an IPv6 multifield classifier policy is applied to ingress traffic on a subinterface.

  • input-ipv6-filter-instances-routed

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on routed subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every routed subinterface using the IPv6 filter.

  • input-ipv6-filter-instances-bridged

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on bridged subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every bridged subinterface using the IPv6 filter.

  • if-input-ipv4-stats

    Resource pool of stats entries available for ingress IPv4 ACLs

  • if-input-ipv6-stats

    Resource pool of stats entries available for ingress IPv6 ACLs

  • if-output-ipv4-stats

    Resource pool of stats entries available for egress IPv4 ACLs

  • if-output-ipv6-stats

    Resource pool of stats entries available for egress IPv6 ACLs

  • if-output-cpm-stats

    Resource pool of stats entries shared by egress IPv4/IPv6/MAC TCAM entries, and CPM-filter IPv4/IPv6/MAC TCAM entries

    Egress Ipv4 -> uses single stat counter Egress Ipv6 -> uses single stat counter Egress MAC -> uses single stat counter Cpm Ipv4 -> uses two stat counters Cpm Ipv6 -> uses two stat counters Cpm MAC -> uses two stat counters

  • input-acl-qos-template-policers

    This resource is used every time an IPv4 or IPv6 input subinterface filter entry uses a rate-limit policer, or subinterface policer-template is used.

  • output-acl-cpm-filter-policers

    This resource is used every time an IPv4 or IPv6 output subinterface filter or CPM filter entry uses a rate-limit policer.

ConfigurableFalse
PlatformsSupported on all platforms
buffer-memory
Description Container for utilization statistics of the packet buffer memory
Contextplatform linecard slot number forwarding-complex name keyword buffer-memory
Treebuffer-memory
ConfigurableTrue
Platforms7220 IXR-H2, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7220 IXR-D5, 7220 IXR-D2L, 7220 IXR-H4
free number
Description Available buffer memory, which equals the total memory less the used memory and the reserved memory.
Contextplatform linecard slot number forwarding-complex name keyword buffer-memory free number
Treefree
Unitsbytes
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7220 IXR-D5, 7220 IXR-D2L, 7220 IXR-H4
reserved number
Description Buffer memory reserved for proper system operation and by the user (due to assignment of non-zero CBS for certain queues, on platforms that support CBS).
Contextplatform linecard slot number forwarding-complex name keyword buffer-memory reserved number
Treereserved
Unitsbytes
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7220 IXR-D5, 7220 IXR-D2L, 7220 IXR-H4
sram
Description Container for utilization statistics of the on-chip SRAM memory.
Contextplatform linecard slot number forwarding-complex name keyword buffer-memory sram
Treesram
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
used number
Description Used buffer memory, excluding reserved memory.
Contextplatform linecard slot number forwarding-complex name keyword buffer-memory used number
Treeused
Unitsbytes
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7220 IXR-D5, 7220 IXR-D2L, 7220 IXR-H4
datapath
Description Container for monitoring datapath resources of a particular forwarding complex
Contextplatform linecard slot number forwarding-complex name keyword datapath
Treedatapath
ConfigurableFalse
PlatformsSupported on all platforms
asic
Description Container for monitoring ASIC-specific datapath resources
Contextplatform linecard slot number forwarding-complex name keyword datapath asic
Treeasic
ConfigurableFalse
PlatformsSupported on all platforms
resource name identityref
Description List of ASIC-specific datapath resources.
Contextplatform linecard slot number forwarding-complex name keyword datapath asic resource name identityref
Treeresource
ConfigurableFalse
PlatformsSupported on all platforms
name identityref
Description The name of the ASIC-specific datapath resource
Contextplatform linecard slot number forwarding-complex name keyword datapath asic resource name identityref
Options

  • ip-lpm-ipv4-routes

    Trident3: Reports the number of IPv4 entries in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of half-wide entries in all partitions (i.e. it assumes no IPv6 routes consume those entries). In ALPM mode, free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

    Trident4 and Tomahawk3: Reports the number of IPv4 routes installed in the FIB. Free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-routes

    Reports the number of IPv6 routes installed in the FIB. Free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-shorter-routes

    Trident3: Reports the number of IPv6 entries with prefix length less than 65 bits in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of single-wide + double-wide entries (i.e. it assumes no other types of routes consume those entries). In ALPM mode, free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

    Tomahawk3: Reports the number of IPv6 entries with prefix length less than 65 bits installed in the FIB. Free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-longer-routes

    Trident3: Reports the number of IPv6 entries with prefix length greater than 64 bits in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of double-wide entries (i.e. it assumes no other types of routes consume those entries). In ALPM mode, free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

    Tomahawk3: Reports the number of IPv6 entries with prefix length greater than 64 bits installed in the FIB. Free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

  • exact-match-entries

    Reports the number of half-wide entries used in the LEM table. Each MPLS ILM record uses one half-wide entry. Each IPv4 address used as a host route, ARP entry or subnet broadcast address requires a half-wide entry. An IPv6 address used as a host route, or ND entry requires a single-wide entry (2 half-wide entries). Free entries is the remaining number of half-wide entries.

  • underlay-ecmp-groups

    Underlay ECMP group resources.

    ECMP groups are partitioned into overlay and underlay groups. The underlay partition is further subdivided into groups used for underlay ECMP and groups used for VP LAGs (EVPN M-H). This counts the utilization of the sub-resource used for ECMP.

  • vp-lag-groups

    VP LAG group resources.

    ECMP groups are partitioned into overlay and underlay groups. The underlay partition is further subdivided into groups used for underlay ECMP and groups used for VP LAGs (EVPN M-H). This counts the utilization of the sub-resource used for VP LAGs.

  • overlay-ecmp-groups

    Overlay ECMP group resources.

    ECMP groups are partitioned into overlay and underlay groups. This counts the utilization of the overlay ECMP partition.

  • underlay-ecmp-members

    Underlay ECMP member resources.

    ECMP members are partitioned into overlay and underlay. This counts the utilization of the partition used for underlay.

  • overlay-ecmp-members

    Overlay ECMP member resources.

    ECMP members are partitioned into overlay and underlay. This counts the utilization of the partition used for overlay.

  • underlay-egress-next-hops

    Underlay egress next-hop resources.

    Egress next-hops are partitioned into overlay and underlay. This counts the utilization of the partition used for underlay.

  • overlay-egress-next-hops

    Overlay egress next-hop resources.

    Egress next-hops are partitioned into overlay and underlay. This counts the utilization of the partition used for overlay.

  • dgpp-module-ids

    DGPP module ID resources.

    DGPPs are an aggregate id consisting of a module_id and a port_id. There are 64 modules and 120 ports per module. Each 'network' ARP entry (IP next-hop) needs a DGPP - the module_id is allocated against the network interface (port) and a port_id is allocated from within the module. A module_id will only be allocated when the first ArpEntry is added (freed when last is removed) but is owned exclusively by that network interface. A network interface may require more than one module_id - i.e. if there are 245 ArpEntries on ethernet-1/1 (possibly spread across multiple network-instance interfaces) then 3 module_ids are required.

  • egress-vlan-translate-egress-vnis

    EGR_VLAN_XLATE_1 resources.

    Corresponds to the 'EGR_VLAN_XLATE_1' HW table (8K entries). These entries are used for finding the egress VNI to be used for VXLAN packets.

  • egress-vlan-translate-local-bias-pairs

    EGR_VLAN_XLATE_2 resources.

    Corresponds to the 'EGR_VLAN_XLATE_2' HW table (24K entries). These entries are used for local bias (ES pruning).

  • level-1-ecmp-groups

    L1 ECMP group resources.

    ECMP FEC resources are divided into L1 ECMP FEC resources and L2 ECMP FEC resources. This counts the number of entries used in the L1 partition.

  • level-2-ecmp-groups

    L2 ECMP group resources.

    ECMP FEC resources are divided into L1 ECMP FEC resources and L2 ECMP FEC resources. This counts the number of entries used in the L2 partition.

  • level-1-ecmp-members

    L1 ECMP member resources.

    ECMP FEC member resources are divided into L1 and L2 resources. This counts the number of entries used in the L1 partition.

  • level-2-ecmp-members

    L2 ECMP member resources.

    ECMP FEC member resources are divided into L1 and L2 resources. This counts the number of entries used in the L2 partition.

  • level-1-non-ecmp-fecs

    L1 non-ECMP FEC resources.

    Non-ECMP FEC resources are divided into L1 and L2 resources. This counts the number of entries used in the L1 partition.

  • level-2-non-ecmp-fecs

    L2 non-ECMP FEC resources.

    Non-ECMP FEC resources are divided into L1 and L2 resources. This counts the number of entries used in the L2 partition.

ConfigurableFalse
PlatformsSupported on all platforms
xdp
Description Container for monitoring datapath resources that are generic in concept.
Contextplatform linecard slot number forwarding-complex name keyword datapath xdp
Treexdp
ConfigurableFalse
PlatformsSupported on all platforms
resource name identityref
Description List of generic datapath resources.
Context platform linecard slot number forwarding-complex name keyword datapath xdp resource name identityref
Treeresource
ConfigurableFalse
PlatformsSupported on all platforms
name identityref
Description The name of the XDP datapath resource
Contextplatform linecard slot number forwarding-complex name keyword datapath xdp resource name identityref
Options

  • arp-nd-entries

    IPv4 ARP and IPv6 neighbor discovery resources.

    Each IPv4 ARP and each IPv6 neighbor entry counts as 1 used resource against a total that is platform dependent. This does not consider underlying ASIC resources.

  • ip-hosts

    IP host route resources.

    Trident3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. In non-ALPM operation every remote /32 route also requires 1 entry. Every local host /128 route, and ND entry requires 2 entries. In non-ALPM operation every remote /128 route also requires 2 entries. Free entries reflects the total number of entries remaining in shared + dedicated UFT banks

    Trident4 and Tomahawk3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. Every local host /128 route, and ND entry requires 2 entries.

  • ip-lpm-routes

    IP longest prefix match route resources.

    Jericho2: Every installed IPv4 and IPv6 route counts as one used route.

    Trident3 and Tomahawk3: In ALPM-disabled mode: Reports the number of half-wide entries. An IPv4 route requires a half-wide entry. An IPv6 route that is /64 or less requires a single-wide entry (2 half-wide entries). An IPv6 route that is more than /64 requires a double-wide entry (4 half-wide entries). In ALPM mode: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 2 used routes.

    Trident4: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 4 used routes.

  • mac-addresses

    MAC address resources.

    Reports the number of entries used in the MAC lookup table. On TD3, free entries reflects the total number of entries remaining in shared + dedicated UFT banks

  • direct-next-hops

    Direct next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP or MPLS route that is resolved directly to a local interface. This does not consider underlying ASIC resources.

  • indirect-next-hops

    Indirect next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP route that is resolved by a non-local route. This does not consider underlying ASIC resources.

  • tunnel-next-hops

    Tunnel next-hop resources.

    Reports the number of tunnel next-hop entries. For EVPN routes resolved by VXLAN, 1 entry is used for every <vni, vtep> pair. When a BGP IP route is resolved by an MPLS tunnel, 1 entry is used for every BGP next-hop of the route. This does not consider underlying ASIC resources.

  • ecmp-groups

    ECMP group resources.

    Jericho2: Reports the used number of ECMP FECs, adding L1 ECMP FECs and L2 ECMP FECs.

    Trident3: Reports the used number of ECMP groups, adding overlay and underlay ECMP groups.

    Trident4 and Tomahawk3: Reports used number of ECMP groups.

  • ecmp-members

    ECMP member resources.

    Jericho2: Reports the used number of ECMP member FECs, adding L1 ECMP member FECs and L2 ECMP member FECs.

    Trident3: Reports the used number of ECMP members, adding overlay and underlay ECMP members.

    Trident4 and Tomahawk3: Reports used number of ECMP members.

  • egress-next-hops

    Egress next-hop resources.

    Trident3: Reports the number of entries used in the egress next-hop table, counting entries in the overlay partition and entries in the underlay partition. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

    Trident4 and Tomahawk3: Reports the number of entries used in the egress next-hop table. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

  • lag-groups

    LAG group resources.

    Reports the number of LAG resources used, including DGPP LAGs.

  • lag-members

    LAG member resources.

    Reports the number of LAG member resources used, including DGPP LAG members.

  • subinterfaces

    Subinterface resources.

    There are a maximum of 127 subinterfaces per TH3 pipeline (limited by VFP/EFP TCAM resources). This counts the utilization of those resources.

  • mpls-next-hops

    One resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an ILM entry that performs a 'swap'. One additional resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an MPLS tunnel.

  • mpls-incoming-labels

    One resource is used for every MPLS ILM entry that performs either a 'swap' or a 'pop' operation.

  • tunnels

    Tunnel resources. One tunnel resource is used per VXLAN or MPLS tunnel endpoint.

    On TD3 and TD4 systems this equates to a DVP resource.

ConfigurableFalse
PlatformsSupported on all platforms
fabric
Description Top-level container for fabric configuration and state
Contextplatform linecard slot number forwarding-complex name keyword fabric
Treefabric
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
fib-table
Description Enter the fib-table context
Context platform linecard slot number forwarding-complex name keyword fib-table
Treefib-table
ConfigurableFalse
PlatformsSupported on all platforms
next-hop-group index number
Description List of next hop groups (NHGs) in the FIB table
Contextplatform linecard slot number forwarding-complex name keyword fib-table next-hop-group index number
Treenext-hop-group
ConfigurableFalse
PlatformsSupported on all platforms
backup-next-hop-group reference
Description The backup next-hop-group for the current group. When all entries within the next-hop group become unusable, the backup next-hop group is used if specified.
Contextplatform linecard slot number forwarding-complex name keyword fib-table next-hop-group index number backup-next-hop-group reference
Treebackup-next-hop-group
Referenceplatform linecard slot number forwarding-complex name keyword fib-table next-hop-group index number
ConfigurableFalse
PlatformsSupported on all platforms
next-hop id number
Description Enter the next-hop list instance
Context platform linecard slot number forwarding-complex name keyword fib-table next-hop-group index number next-hop id number
Treenext-hop
ConfigurableFalse
PlatformsSupported on all platforms
oper-state keyword
Description Operational state of the next-hop group
Contextplatform linecard slot number forwarding-complex name keyword fib-table next-hop-group index number oper-state keyword
Treeoper-state
Options

  • up

    The NHG or NH is fully resolved and operational

  • down

    The NHG or NH is unresolved and not viable for carrying traffic

  • failed

    The NHG or NH is not operational because of an underlying hardware resource issue

ConfigurableFalse
PlatformsSupported on all platforms
last-booted string
Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform linecard slot number forwarding-complex name keyword last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
last-booted-reason identityref
Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform linecard slot number forwarding-complex name keyword last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms
mtu
Description Enter the mtu context
Context platform linecard slot number forwarding-complex name keyword mtu
Treemtu
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
resource name identityref
Description Enter the resource list instance
Context platform linecard slot number forwarding-complex name keyword mtu resource name identityref
Treeresource
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
name identityref
Description The name of the MTU resource
Context platform linecard slot number forwarding-complex name keyword mtu resource name identityref
Options

  • ip-mtu

    IP MTU resource pool. One resource from this pool is consumed by every different IP MTU value used by the subinterfaces on the linecard forwarding-complex.

  • port-mtu

    Port MTU resource pool. One resource from this pool is consumed by every different port MTU value used by a port on the linecard forwarding-complex.

  • mpls-mtu

    MPLS MTU resource pool. One resource from this pool is consumed by every different MPLS MTU value used by the subinterfaces on the linecard forwarding-complex.

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
oper-state keyword
Description The operational state of this component
Contextplatform linecard slot number forwarding-complex name keyword oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms
p4rt
Description Top-level container for P4Runtime forwarding complex configuration and state
Contextplatform linecard slot number forwarding-complex name keyword p4rt
Treep4rt
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
id number
Description

The numeric ID used by the controller to address the forwarding complex

This ID may be referred to as a 'device', 'node' or 'target' by the P4RT specification.

Each ASIC is addressed by the client based on this numeric identifier.

Contextplatform linecard slot number forwarding-complex name keyword p4rt id number
Treeid
Range1 to 18446744073709551615
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
pipeline index (number | keyword)
Description List of pipelines that make up one forwarding complex.
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword)
Treepipeline
ConfigurableTrue
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
index (number | keyword)
Description The pipeline number (TH3 systems) or direction (J2 and J2C+ systems).
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword)
Range0 to 7
Options

  • egress

    Applicable to J2 and J2C+ systems only

  • ingress

    Applicable to J2 and J2C+ systems only

ConfigurableTrue
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
datapath
Description Container for monitoring datapath resources of a particular pipeline
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) datapath
Treedatapath
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
xdp
Description

Container for monitoring datapath resources that are generic in concept.

At the pipeline level only one XDP resource is currently reported:

Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) datapath xdp
Treexdp
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
resource name identityref
Description List of generic datapath resources.
Context platform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) datapath xdp resource name identityref
Treeresource
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
name identityref
Description The name of the XDP datapath resource
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) datapath xdp resource name identityref
Options

  • arp-nd-entries

    IPv4 ARP and IPv6 neighbor discovery resources.

    Each IPv4 ARP and each IPv6 neighbor entry counts as 1 used resource against a total that is platform dependent. This does not consider underlying ASIC resources.

  • ip-hosts

    IP host route resources.

    Trident3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. In non-ALPM operation every remote /32 route also requires 1 entry. Every local host /128 route, and ND entry requires 2 entries. In non-ALPM operation every remote /128 route also requires 2 entries. Free entries reflects the total number of entries remaining in shared + dedicated UFT banks

    Trident4 and Tomahawk3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. Every local host /128 route, and ND entry requires 2 entries.

  • ip-lpm-routes

    IP longest prefix match route resources.

    Jericho2: Every installed IPv4 and IPv6 route counts as one used route.

    Trident3 and Tomahawk3: In ALPM-disabled mode: Reports the number of half-wide entries. An IPv4 route requires a half-wide entry. An IPv6 route that is /64 or less requires a single-wide entry (2 half-wide entries). An IPv6 route that is more than /64 requires a double-wide entry (4 half-wide entries). In ALPM mode: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 2 used routes.

    Trident4: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 4 used routes.

  • mac-addresses

    MAC address resources.

    Reports the number of entries used in the MAC lookup table. On TD3, free entries reflects the total number of entries remaining in shared + dedicated UFT banks

  • direct-next-hops

    Direct next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP or MPLS route that is resolved directly to a local interface. This does not consider underlying ASIC resources.

  • indirect-next-hops

    Indirect next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP route that is resolved by a non-local route. This does not consider underlying ASIC resources.

  • tunnel-next-hops

    Tunnel next-hop resources.

    Reports the number of tunnel next-hop entries. For EVPN routes resolved by VXLAN, 1 entry is used for every <vni, vtep> pair. When a BGP IP route is resolved by an MPLS tunnel, 1 entry is used for every BGP next-hop of the route. This does not consider underlying ASIC resources.

  • ecmp-groups

    ECMP group resources.

    Jericho2: Reports the used number of ECMP FECs, adding L1 ECMP FECs and L2 ECMP FECs.

    Trident3: Reports the used number of ECMP groups, adding overlay and underlay ECMP groups.

    Trident4 and Tomahawk3: Reports used number of ECMP groups.

  • ecmp-members

    ECMP member resources.

    Jericho2: Reports the used number of ECMP member FECs, adding L1 ECMP member FECs and L2 ECMP member FECs.

    Trident3: Reports the used number of ECMP members, adding overlay and underlay ECMP members.

    Trident4 and Tomahawk3: Reports used number of ECMP members.

  • egress-next-hops

    Egress next-hop resources.

    Trident3: Reports the number of entries used in the egress next-hop table, counting entries in the overlay partition and entries in the underlay partition. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

    Trident4 and Tomahawk3: Reports the number of entries used in the egress next-hop table. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

  • lag-groups

    LAG group resources.

    Reports the number of LAG resources used, including DGPP LAGs.

  • lag-members

    LAG member resources.

    Reports the number of LAG member resources used, including DGPP LAG members.

  • subinterfaces

    Subinterface resources.

    There are a maximum of 127 subinterfaces per TH3 pipeline (limited by VFP/EFP TCAM resources). This counts the utilization of those resources.

  • mpls-next-hops

    One resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an ILM entry that performs a 'swap'. One additional resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an MPLS tunnel.

  • mpls-incoming-labels

    One resource is used for every MPLS ILM entry that performs either a 'swap' or a 'pop' operation.

  • tunnels

    Tunnel resources. One tunnel resource is used per VXLAN or MPLS tunnel endpoint.

    On TD3 and TD4 systems this equates to a DVP resource.

ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-H3, 7250 IXR-6e, 7250 IXR-10, 7250 IXR-6, 7250 IXR-10e
pipeline-counters
Description Top-level container for the packet counters associated with the different NPU sub-blocks.
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters
Treepipeline-counters
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
host-interface-block
Description The ASIC host interface block subsystem that connects the NPU to the host CPU (on the CPM)
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block
Treehost-interface-block
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
packet-extraction
Description Packet extraction from the NPU towards the CPU
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction
Treepacket-extraction
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
extracted-octets number
Description The number of octets in Ethernet frames extracted towards the CPU from the pipeline; this includes packets that might be dropped (due to congestion or rate limiting) before reaching the final consuming application on the CPM
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extracted-octets number
Treeextracted-octets
Default0
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
extracted-packets number
Description The number of Ethernet frames extracted towards the CPU from the pipeline; this includes packets that might be dropped (due to congestion or rate limiting) before reaching the final consuming application on the CPM
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extracted-packets number
Treeextracted-packets
Default0
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
extraction-reason reason identityref
Description List of extraction reasons that are possible for the pipeline
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extraction-reason reason identityref
Treeextraction-reason
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
reason identityref
Description A reason for extracting the packet towards the host CPU
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extraction-reason reason identityref
Options

  • ipv4-header-options

    IPv4 header options are present in the packet.

  • ipv6-hop-by-hop-option

    IPv6 packet with topmost next-header value of zero.

  • icmp

    ICMPv4 packets with this router as destination.

  • icmp6

    ICMPv6 packets including neighbor-solicitation and neighbor-advertisement messages.

  • icmp-redirect

    Received IPv4 and IPv6 packets that should cause an ICMP redirect to be generated.

  • bfd

    BFD and micro-BFD packets with this router as destination.

  • bgp

    BGP packets; TCP port 179.

  • grpc

    GRPC packets; TCP port 57400

  • ospf

    OSPF packets; IP protocol 89

  • vrrp

    VRRP packets; IP protocol 112

  • ldp

    LDP packets; UDP port 646

  • dhcp

    DHCP packets; UDP ports 67,68

  • ip-other-terminating

    Any other IP packets that are locally destined

  • ip-blackhole-icmp

    Traffic matched a blackhole route with generate-icmp=true

  • ipv6-multicast

    IPv6 DA = FF01:0:0:0:0:0:0:1 or IPv6 DA = FF01:0:0:0:0:0:0:2

  • ipv6-link-local

    IPv6 DA = FE80::/10 address

  • ipv4-broadcast

    IPv4 packets were received with a subnet broadcast address or a limited broadcast and not recognized as another type

  • ip-no-route

    IPv4 and IPv6 packets for which there was no route to the destination

  • ip-header-errors

    IP version error, IP header checksum error, IP header length error, IP header total length error, IPv6 next-header is null, IPv6 SA is link-local while IPv6 DA is global

  • ip-ttl-expired

    The IP packet is not destined for this router and it was received with TTL 0 or TTL 1

  • mpls-ttl-expired

    The MPLS packet was received with MPLS label stack TTL 0 or TTL 1

  • ip-arp-miss

    The IP DA itself or the next-hop of the route used to forward the packet has no ARP/IPv6 neighbor entry

  • ip-arp

    The received frame is an ARP packet recognized by ethertype 0x0806

  • lldp

    The received frame is an LLDP packet recognized by ethertype 0x88cc

  • isis

    The received frame is an ISIS packet

  • lacp

    The received frame is an LACP packet

  • google-discovery

    The received frame is a GDP packet recognized by ethertype 0x6007

  • capture-filter-copy

    Packets matching a capture-filter copy rule

  • cpm-filter-log

    Packets matching a CPM-filter rule with log action

  • ingress-acl-log

    Packets matching an interface IP filter rule with log action

  • egress-acl-log

    Packet matched an egress ACL rule with log action.

  • ip-mpls-mtu-exceeded

    The egress subinterface IP MTU or MPLS MTU (as applicable) is less than the size of the IP or MPLS packet that needs to be transmitted.

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
extracted-octets number
Description The number of octets in Ethernet frames extracted towards the CPU from the pipeline; this includes packets that might be dropped (due to congestion or rate limiting) before reaching the final consuming application on the CPM
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extraction-reason reason identityref extracted-octets number
Treeextracted-octets
Default0
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
extracted-packets number
Description The number of Ethernet frames extracted towards the CPU from the pipeline; this includes packets that might be dropped (due to congestion or rate limiting) before reaching the final consuming application on the CPM
Contextplatform linecard slot number forwarding-complex name keyword pipeline index (number | keyword) pipeline-counters host-interface-block packet-extraction extraction-reason reason identityref extracted-packets number
Treeextracted-packets
Default0
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
qos
Description Enter the qos context
Context platform linecard slot number forwarding-complex name keyword qos
Treeqos
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
resource name identityref
Description Enter the resource list instance
Context platform linecard slot number forwarding-complex name keyword qos resource name identityref
Treeresource
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
name identityref
Description The name of the QoS resource
Context platform linecard slot number forwarding-complex name keyword qos resource name identityref
Options

  • classifier-profiles

    A classifier-profile resource is used every time a different combination of IPv4 DSCP classifier and IPv6 DSCP classifier is applied to an ingress subinterface of the 7250 IXR IMM. There are 16 of these resources and one is always used by the combination of the default IPv4 DSCP classifier and the default IPv6 DSCP classifier.

  • rewrite-profiles

    On the 7250 IXR, a rewrite-profile resource is used every time a different combination of IPv4 DSCP rewrite-rule and IPv6 DSCP rewrite-rule is applied to an egress subinterface of the 7250 IXR IMM. There are 32 of these resources.

  • rewrite-policies

    A rewrite-policy resource is used every time a different DSCP or MPLS traffic-class rewrite-rule policy is applied to an egress subinterface of the 7250 IXR IMM. There are 32 of these resources.

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
tcam
Description Enter the tcam context
Context platform linecard slot number forwarding-complex name keyword tcam
Treetcam
ConfigurableFalse
PlatformsSupported on all platforms
resource name identityref
Description Enter the resource list instance
Context platform linecard slot number forwarding-complex name keyword tcam resource name identityref
Treeresource
ConfigurableFalse
PlatformsSupported on all platforms
name identityref
Description The name of the TCAM resource
Context platform linecard slot number forwarding-complex name keyword tcam resource name identityref
Options

  • if-input-ipv4

    Resource pool of TCAM entries used by IPv4 ACLs applied as subinterface-input filers

  • if-output-ipv4

    Resource pool of TCAM entries used by IPv4 ACLs applied as subinterface-output filers

  • if-input-ipv6

    Resource pool of TCAM entries used by IPv6 ACLs applied as subinterface-input filers

  • if-output-ipv6

    Resource pool of TCAM entries used by IPv6 ACLs applied as subinterface-output filers

  • cpm-capture-ipv4

    Resource pool of TCAM entries used by IPv4 cpm-filter ACLs and capture-filter ACLs

  • cpm-capture-ipv6

    Resource pool of TCAM entries used by IPv6 cpm-filter ACLs and capture-filter ACLs

  • system-capture-ipv4

    Resource pool of TCAM entries used by IPv4 capture-filter ACLs and IPv4 system-filter ACLs

  • system-capture-ipv6

    Resource pool of TCAM entries used by IPv6 capture-filter ACLs and IPv6 system-filter ACLs

  • system-capture

    Resource pool of TCAM entries used by IPv4 + IPv6 capture-filter ACLs and system-filter ACLs

  • capture-ipv4

    Resource pool of TCAM entries used by IPv4 capture-filter ACLs

  • capture-ipv6

    Resource pool of TCAM entries used by IPv6 capture-filter ACLs

  • if-output-cpm-ipv4

    Resource pool of TCAM entries used by IPv4 egress ACLs and cpm-filter ACLs

  • if-output-cpm-ipv6

    Resource pool of TCAM entries used by IPv6 egress ACLs and cpm-filter ACLs

  • if-output-cpm

    Resource pool of TCAM entries used by IPv4 + IPv6 egress ACLs and cpm-filter ACLs

  • if-input-mac

    Resource pool of TCAM entries used by MAC ACLs applied as subinterface-input filers

  • if-output-cpm-mac

    Resource pool of TCAM entries used by MAC egress ACLs and MAC cpm-filter ACLs

  • policy-forwarding-ipv4

    Resource pool of TCAM entries used by IPv4 policy-forwarding entries

  • if-input-policer

    Resource pool of TCAM entries used by ingress subinterface policer templates

  • if-input-ipv4-qos

    Resource pool of TCAM entries associated with IPv4 multi-field QoS classification entries, when applied to subinterface input

  • if-input-ipv6-qos

    Resource pool of TCAM entries associated with IPv6 multi-field QoS classification entries, when applied to subinterface input

ConfigurableFalse
PlatformsSupported on all platforms
free-dynamic number
Description The number of available and unused TCAM entries for the entry type, assuming that all the remaining unused TCAM slices would be dynamically allocated to this one type of entry (subject to chip level constraints on the placement of double-wide and triple-wide TCAM slice groups).
Contextplatform linecard slot number forwarding-complex name keyword tcam resource name identityref free-dynamic number
Treefree-dynamic
ConfigurableFalse
Platforms7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D3L, 7250 IXR-6, 7250 IXR-10, 7250 IXR-6e, 7220 IXR-D5, 7250 IXR-10e, 7220 IXR-D2L
free-static number
Description The number of available and unused TCAM entries for the entry type, assuming that the number of dynamic TCAM slices that are currently allocated to the entry type remains constant at its current value.
Contextplatform linecard slot number forwarding-complex name keyword tcam resource name identityref free-static number
Treefree-static
ConfigurableFalse
PlatformsSupported on all platforms
programmed number
Description The number of TCAM entries belonging to this resource that are currently programmed into hardware. When the number of programmed entries equals the number of reserved entries HW programming of this resource type has finished.
Contextplatform linecard slot number forwarding-complex name keyword tcam resource name identityref programmed number
Treeprogrammed
ConfigurableFalse
PlatformsSupported on all platforms
reserved number
Description The number of TCAM entries that are currently reserved in this resource pool. Reservation happens when a configuration change is committed. Reserved entries may not be programmed yet if the commit has just occurred.
Contextplatform linecard slot number forwarding-complex name keyword tcam resource name identityref reserved number
Treereserved
ConfigurableFalse
PlatformsSupported on all platforms

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform linecard slot number healthz
Treehealthz
ConfigurableFalse
PlatformsSupported on all platforms
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform linecard slot number healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform linecard slot number healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
PlatformsSupported on all platforms
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform linecard slot number healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
PlatformsSupported on all platforms

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform linecard slot number last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform linecard slot number last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms

last-change string

Description The date and time this component last changed state
Contextplatform linecard slot number last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

locator-state keyword

Description Details if the locator LED is active on this component
Contextplatform linecard slot number locator-state keyword
Treelocator-state
Defaultinactive
Options

  • active

    Locator LED is currently active

  • inactive

    Locator LED is currently inactive

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

oper-state keyword

Description The operational state of this component
Contextplatform linecard slot number oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms

power

Description State related to power consumption and allocation for this component
Contextplatform linecard slot number power
Treepower
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
required number
Description The power budget required to enable this component
Contextplatform linecard slot number power required number
Treerequired
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
used number
Description The power in use by this component
Context platform linecard slot number power used number
Treeused
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

rebooting-at string

Description

Indicates the date and time this component will reboot

If empty, no delayed reboots are queued for this component.

A non empty value implies that a delayed reboot operation has been triggered for this component, which can be aborted using 'tools platform <component> reboot cancel'.

Contextplatform linecard slot number rebooting-at string
Treerebooting-at
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

removable boolean

Description Details if this component can be removed from the system
Contextplatform linecard slot number removable boolean
Treeremovable
ConfigurableFalse
PlatformsSupported on all platforms

software-version string

Description

Image version version running on this component

This version is the squashfs version, and may not represent the current per-application versions if versions have been modified after the system has been installed.

Contextplatform linecard slot number software-version string
Treesoftware-version
ConfigurableFalse
PlatformsSupported on all platforms

temperature

Description State related to temperature for this component
Contextplatform linecard slot number temperature
Treetemperature
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
alarm-status boolean
Description

Indicates if a temperature sensor of this component is currently in an alarm state

An alarm state is triggered if the margin field is <=2 degrees, indicating that a thermal protection shut down is imminent unless adequate system cooling is provided to bring the temperature sensor back into safe operating ranges.

Contextplatform linecard slot number temperature alarm-status boolean
Treealarm-status
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
instant number
Description

Represents the highest temperature of any sensor on this component

Note that as multiple sensors may feed in, that this field and the margin field may be referencing different sensors.

Contextplatform linecard slot number temperature instant number
Treeinstant
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
margin number
Description

Indicates the lowest alarm margin of any sensor on this component

The margin is the delta between the current sensor temperature and the thermal protection threshold for that sensor. Note that as multiple sensors may feed in, that this field and the instant field may be referencing different sensors.

Contextplatform linecard slot number temperature margin number
Treemargin
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

type string

Description Linecard type, as translated from the components EEPROM
Contextplatform linecard slot number type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms

power-supply id number

Description Top-level container for power supply module configuration and state
Contextplatform power-supply id number
Treepower-supply
ConfigurableFalse
PlatformsSupported on all platforms

id number

Description Numeric identifier for the power supply module
Contextplatform power-supply id number
Range1 to 255
ConfigurableFalse
PlatformsSupported on all platforms

capacity number

Description The total capacity the power supply module can provide
Contextplatform power-supply id number capacity number
Treecapacity
Unitswatts
ConfigurableFalse
PlatformsSupported on all platforms

clei-code string

Description The Common Language Identification Code for this component
Contextplatform power-supply id number clei-code string
Treeclei-code
ConfigurableFalse
PlatformsSupported on all platforms

failure-reason string

Description

The reason the component transitioned to a failed state

Field is empty if the component is not currently in a failure state

Contextplatform power-supply id number failure-reason string
Treefailure-reason
ConfigurableFalse
PlatformsSupported on all platforms

fan

Description Top-level container for state relating to fans
Contextplatform power-supply id number fan
Treefan
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
speed number
Description The current speed of the fan
Context platform power-supply id number fan speed number
Treespeed
Range0 to 100
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

feed id number

Description List of feeds on this power-supply
Context platform power-supply id number feed id number
Treefeed
ConfigurableFalse
Platforms7250 IXR-10e, 7250 IXR-6e
id number
Description ID of the feed
Context platform power-supply id number feed id number
ConfigurableFalse
Platforms7250 IXR-10e, 7250 IXR-6e
current decimal-number
Description Current input amperage of this feed
Context platform power-supply id number feed id number current decimal-number
Treecurrent
Unitsamps
ConfigurableFalse
Platforms7250 IXR-10e, 7250 IXR-6e
voltage decimal-number
Description Current input voltage for this feed
Context platform power-supply id number feed id number voltage decimal-number
Treevoltage
Unitsvolts
ConfigurableFalse
Platforms7250 IXR-10e, 7250 IXR-6e

healthz

Description

The health of the component

The paramaters within this container indicate the status of the component beyond whether it is operationally up or down. When a signal is received that a component is in an unhealthy state the gNOI.Healthz service can be used to retrieve further diagnostic information relating to the component. The contents of this directory relate only to the specific component that it is associated with.

Contextplatform power-supply id number healthz
Treehealthz
ConfigurableFalse
PlatformsSupported on all platforms
last-unhealthy string
Description

Last unhealthy time

The time at which the component was last observed to transition from the HEALTHY state to any other state, represented as nanoseconds since the Unix epoch.

Contextplatform power-supply id number healthz last-unhealthy string
Treelast-unhealthy
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
status keyword
Description

Health status

The status of the component, indicating its current health.

Contextplatform power-supply id number healthz status keyword
Treestatus
Options

  • UNSPECIFIED

    Unspecified status

    The component's health status has not yet been checked by the system.

  • HEALTHY

    Healthy status

    The component is in a HEALTHY state, and is operating within the expected parameters.

  • UNHEALTHY

    Unhealthy status

    The component is in a unhealthy state, it is not performing the function expected of it.

ConfigurableFalse
PlatformsSupported on all platforms
unhealthy-count number
Description

Unhealthy count

The number of times the component has transitioned from the HEALTHY state to any other state.

Contextplatform power-supply id number healthz unhealthy-count number
Treeunhealthy-count
Default0
ConfigurableFalse
PlatformsSupported on all platforms

input

Description Top-level container for power-supply input state
Contextplatform power-supply id number input
Treeinput
ConfigurableFalse
PlatformsSupported on all platforms
current decimal-number
Description Current amperage input/output for the power-supply
Contextplatform power-supply id number input current decimal-number
Treecurrent
Unitsamps
ConfigurableFalse
PlatformsSupported on all platforms
power decimal-number
Description Current power input/output for the power-supply
Contextplatform power-supply id number input power decimal-number
Treepower
Unitswatts
ConfigurableFalse
PlatformsSupported on all platforms
voltage decimal-number
Description Current voltage input/output for the power-supply
Contextplatform power-supply id number input voltage decimal-number
Treevoltage
Unitsvolts
ConfigurableFalse
PlatformsSupported on all platforms

last-booted string

Description

The date and time this component last booted

For components that do not boot, this is the time the component was last discovered by the active control module

Contextplatform power-supply id number last-booted string
Treelast-booted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

last-booted-reason identityref

Description

The reason this component last booted or rebooted

For components without the ability to 'boot' this field is never populated

Contextplatform power-supply id number last-booted-reason identityref
Treelast-booted-reason
Options

  • user-initiated-reboot

    A user initiated the reboot directly via a management interface

  • power-failure

    The system rebooted the component due to insufficient power

  • critical-error

    The system rebooted the component due to an internal critical error

ConfigurableFalse
PlatformsSupported on all platforms

last-change string

Description The date and time this component last changed state
Contextplatform power-supply id number last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms

oper-reason keyword

Description Indicates the reason for the current state of the component
Contextplatform power-supply id number oper-reason keyword
Treeoper-reason
Options

  • no-input/fault

    No power input, or other hardware fault detected

  • eeprom-invalid

    EEPROM of this power supply is either invalid or corrupt

  • airflow-mismatch

    The detected airflow of this power supply does not match the system-calculated airflow direction

    The logic for determining the system-calculated direction is: - Majority wins between present fan trays - In the case where there are equal F2B or B2F fan-trays, PSUs are used as a tie break (PSUs only are counted in the event a tie breaker is needed) - F2B wins if no tie break can be used

ConfigurableFalse
PlatformsSupported on all platforms

oper-state keyword

Description The operational state of this component
Contextplatform power-supply id number oper-state keyword
Treeoper-state
Options

  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

    This state is set during a warm reboot immediately following initiation of the reboot, continuing after startup until the system has completed audit. In this state the system will not accept configuration changes.

  • waiting

    Component or process is currently waiting

    This state can be set by event handler when the reinvoke-with-delay action is used, and indicates that the event handler is waiting for the provided delay before reinvoking the instance.

ConfigurableFalse
PlatformsSupported on all platforms

output

Description Top-level container for power-supply output state
Contextplatform power-supply id number output
Treeoutput
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
current decimal-number
Description Current amperage input/output for the power-supply
Contextplatform power-supply id number output current decimal-number
Treecurrent
Unitsamps
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
power decimal-number
Description Current power input/output for the power-supply
Contextplatform power-supply id number output power decimal-number
Treepower
Unitswatts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
voltage decimal-number
Description Current voltage input/output for the power-supply
Contextplatform power-supply id number output voltage decimal-number
Treevoltage
Unitsvolts
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

removable boolean

Description Details if this component can be removed from the system
Contextplatform power-supply id number removable boolean
Treeremovable
ConfigurableFalse
PlatformsSupported on all platforms

temperature

Description State related to temperature for this component
Contextplatform power-supply id number temperature
Treetemperature
ConfigurableFalse
PlatformsSupported on all platforms

type string

Description Power-supply type, as translated from the components EEPROM
Contextplatform power-supply id number type string
Treetype
ConfigurableFalse
PlatformsSupported on all platforms

redundancy

Description Top-level container for platform redundancy
Contextplatform redundancy
Treeredundancy
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

active-module keyword

Description Control module currently active
Context platform redundancy active-module keyword
Treeactive-module
Options

  • A

  • B

Configurable False
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

failover-time string

Description Date and time of the last control module failover
Contextplatform redundancy failover-time string
Treefailover-time
String Length20 to 32
ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

synchronization

Description Top-level container for redundancy synchronization
Contextplatform redundancy synchronization
Treesynchronization
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
overlay
Description Top-level container for overlay synchronization
Contextplatform redundancy synchronization overlay
Treeoverlay
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
synchronization-frequency number
Description

Sets the frequency of overlay synchronizations

This has no effect if overlay is not a configured synchronization mode. Changing this value results in the timer to the next synchronization being reset.

Contextplatform redundancy synchronization overlay synchronization-frequency number
Treesynchronization-frequency
Range30 to 65535
Default60
Unitsseconds
Configurable True
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e
state keyword
Description Current synchronization status
Context platform redundancy synchronization state keyword
Treestate
Options

  • synchronized

    Standby control module is ready and synchronized

  • synchronizing

    Standby control module is currently synchronizing

  • not-ready

    Standby control module is not synchronized

ConfigurableFalse
Platforms7250 IXR-10, 7250 IXR-6, 7250 IXR-10e, 7250 IXR-6e

resource-management

Description Container for managing resources in a system-wide context
Contextplatform resource-management
Treeresource-management
ConfigurableTrue
PlatformsSupported on all platforms

tcam

Description Container for managing the allocation of TCAM banks to different applications.
Contextplatform resource-management tcam
Treetcam
ConfigurableTrue
PlatformsSupported on all platforms

unified-forwarding-resources

Description Container for managing Broadcom-specific UFT resources.
Contextplatform resource-management unified-forwarding-resources
Treeunified-forwarding-resources
ConfigurableTrue
Platforms7220 IXR-H2, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D5, 7220 IXR-D2L
alpm keyword
Description

Controls the ALPM mode.

If this is set to disabled then no UFT banks are allocated to ALPM. This mode is not supported by 7220 IXR-D4 or 7220 IXR-D5.

If this is set to enabled then 4 UFT shared banks are allocated to ALPM. This mode is not supported by 7220 IXR-D2 or 7220 IXR-D3.

If this is set to high-scale then 8 UFT shared banks are allocated to ALPM. This mode is not supported by 7220 IXR-D1.

Contextplatform resource-management unified-forwarding-resources alpm keyword
Treealpm
Options

  • disabled

  • enabled

  • high-scale

ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D5, 7220 IXR-D2L
requested-extra-ip-host-entries number
Description

The extra number of host entries that are desired.

The number of UFT shared banks that are reserved for IPv4 and IPv6 host entries is given by: min(N//X,P-A)

where: N = configured value of requested-extra-ip-host-entries X = the size of each shared bank, which is platform specific P-A = platform-specific number of shared banks, subtracting the ALPM banks

requested-extra-ip-host-entries is interpreted in terms of IPv4 hosts (single-wide entries). IPv6 host entries are double-wide so 1 IPv4 host entry + 1 IPv6 host-entry counts as 3 entries.

All UFT shared banks that are not reserved by ALPM and not reserved for extra IP host entries are used for extra MAC entries.

On D1 the default value is 48K entries, which provides 3 shared banks, max is 96K. On D2/D3 the default value is 128K entries, which provides 4 shared banks, max is 256K.

Contextplatform resource-management unified-forwarding-resources requested-extra-ip-host-entries number
Treerequested-extra-ip-host-entries
Range0 to 262144
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D2L
xdp-restart-required boolean
Description Reads true if the user has committed a change to one or more of the configurable values in the uft container but has not yet restarted XDP so the operational values are still the values initialized at the last XDP restart.
Contextplatform resource-management unified-forwarding-resources xdp-restart-required boolean
Treexdp-restart-required
ConfigurableFalse
Platforms7220 IXR-H2, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-H3, 7220 IXR-D3L, 7220 IXR-D1, 7220 IXR-D5, 7220 IXR-D2L

resource-monitoring

Description Enter the resource-monitoring context
Contextplatform resource-monitoring
Treeresource-monitoring
ConfigurableTrue
PlatformsSupported on all platforms

acl

Description Enter the acl context
Context platform resource-monitoring acl
Treeacl
ConfigurableTrue
PlatformsSupported on all platforms
resource name identityref
Description Enter the resource list instance
Context platform resource-monitoring acl resource name identityref
Treeresource
ConfigurableTrue
PlatformsSupported on all platforms
name identityref
Description The name of the ACL resource
Context platform resource-monitoring acl resource name identityref
Options

  • input-ipv4-filter-instances

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on the forwarding complex. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every subinterface using the IPv4 filter.

  • input-ipv4-qos-multifield-instances

    This resource is used every time an IPv4 multifield classifier policy is applied to ingress traffic on a subinterface.

  • input-ipv4-filter-instances-routed

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on routed subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every routed subinterface using the IPv4 filter.

  • input-ipv4-filter-instances-bridged

    This resource is used every time an IPv4 filter instance is created and applied to ingress traffic on bridged subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every bridged subinterface using the IPv4 filter.

  • input-ipv6-filter-instances

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on the forwarding complex. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every subinterface using the IPv6 filter.

  • input-ipv6-qos-multifield-instances

    This resource is used every time an IPv6 multifield classifier policy is applied to ingress traffic on a subinterface.

  • input-ipv6-filter-instances-routed

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on routed subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every routed subinterface using the IPv6 filter.

  • input-ipv6-filter-instances-bridged

    This resource is used every time an IPv6 filter instance is created and applied to ingress traffic on bridged subinterfaces. Only one instance is used if the subinterface-specific property of the filter is set to output-only; otherwise one instance is used for every bridged subinterface using the IPv6 filter.

  • if-input-ipv4-stats

    Resource pool of stats entries available for ingress IPv4 ACLs

  • if-input-ipv6-stats

    Resource pool of stats entries available for ingress IPv6 ACLs

  • if-output-ipv4-stats

    Resource pool of stats entries available for egress IPv4 ACLs

  • if-output-ipv6-stats

    Resource pool of stats entries available for egress IPv6 ACLs

  • if-output-cpm-stats

    Resource pool of stats entries shared by egress IPv4/IPv6/MAC TCAM entries, and CPM-filter IPv4/IPv6/MAC TCAM entries

    Egress Ipv4 -> uses single stat counter Egress Ipv6 -> uses single stat counter Egress MAC -> uses single stat counter Cpm Ipv4 -> uses two stat counters Cpm Ipv6 -> uses two stat counters Cpm MAC -> uses two stat counters

  • input-acl-qos-template-policers

    This resource is used every time an IPv4 or IPv6 input subinterface filter entry uses a rate-limit policer, or subinterface policer-template is used.

  • output-acl-cpm-filter-policers

    This resource is used every time an IPv4 or IPv6 output subinterface filter or CPM filter entry uses a rate-limit policer.

ConfigurableTrue
PlatformsSupported on all platforms
falling-threshold-log number
Description Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the ACL resource in any linecard/complex/core falls reaches this value in a falling direction
Contextplatform resource-monitoring acl resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
PlatformsSupported on all platforms
rising-threshold-log number
Description Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the ACL resource in any linecard/complex/core reaches this value in a rising direction
Contextplatform resource-monitoring acl resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
PlatformsSupported on all platforms

datapath

Description Container for monitoring datapath resources system-wide
Contextplatform resource-monitoring datapath
Treedatapath
ConfigurableTrue
PlatformsSupported on all platforms
asic
Description Container for monitoring datapath resources that are specific to a subset of the chipsets supported by SRLinux.
Contextplatform resource-monitoring datapath asic
Treeasic
ConfigurableTrue
PlatformsSupported on all platforms
resource name identityref
Description List of ASIC-specific datapath resources
Contextplatform resource-monitoring datapath asic resource name identityref
Treeresource
ConfigurableTrue
PlatformsSupported on all platforms
name identityref
Description The name of the ASIC-specific datapath resource.
Contextplatform resource-monitoring datapath asic resource name identityref
Options

  • ip-lpm-ipv4-routes

    Trident3: Reports the number of IPv4 entries in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of half-wide entries in all partitions (i.e. it assumes no IPv6 routes consume those entries). In ALPM mode, free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

    Trident4 and Tomahawk3: Reports the number of IPv4 routes installed in the FIB. Free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-routes

    Reports the number of IPv6 routes installed in the FIB. Free entries is the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-shorter-routes

    Trident3: Reports the number of IPv6 entries with prefix length less than 65 bits in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of single-wide + double-wide entries (i.e. it assumes no other types of routes consume those entries). In ALPM mode, free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

    Tomahawk3: Reports the number of IPv6 entries with prefix length less than 65 bits installed in the FIB. Free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

  • ip-lpm-ipv6-longer-routes

    Trident3: Reports the number of IPv6 entries with prefix length greater than 64 bits in the hardware LPM table. In non-ALPM mode, free entries is the remaining number of double-wide entries (i.e. it assumes no other types of routes consume those entries). In ALPM mode, free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

    Tomahawk3: Reports the number of IPv6 entries with prefix length greater than 64 bits installed in the FIB. Free entries is based on the Minimum Guaranteed Capacity returned by the BCM SDK.

  • exact-match-entries

    Reports the number of half-wide entries used in the LEM table. Each MPLS ILM record uses one half-wide entry. Each IPv4 address used as a host route, ARP entry or subnet broadcast address requires a half-wide entry. An IPv6 address used as a host route, or ND entry requires a single-wide entry (2 half-wide entries). Free entries is the remaining number of half-wide entries.

  • underlay-ecmp-groups

    Underlay ECMP group resources.

    ECMP groups are partitioned into overlay and underlay groups. The underlay partition is further subdivided into groups used for underlay ECMP and groups used for VP LAGs (EVPN M-H). This counts the utilization of the sub-resource used for ECMP.

  • vp-lag-groups

    VP LAG group resources.

    ECMP groups are partitioned into overlay and underlay groups. The underlay partition is further subdivided into groups used for underlay ECMP and groups used for VP LAGs (EVPN M-H). This counts the utilization of the sub-resource used for VP LAGs.

  • overlay-ecmp-groups

    Overlay ECMP group resources.

    ECMP groups are partitioned into overlay and underlay groups. This counts the utilization of the overlay ECMP partition.

  • underlay-ecmp-members

    Underlay ECMP member resources.

    ECMP members are partitioned into overlay and underlay. This counts the utilization of the partition used for underlay.

  • overlay-ecmp-members

    Overlay ECMP member resources.

    ECMP members are partitioned into overlay and underlay. This counts the utilization of the partition used for overlay.

  • underlay-egress-next-hops

    Underlay egress next-hop resources.

    Egress next-hops are partitioned into overlay and underlay. This counts the utilization of the partition used for underlay.

  • overlay-egress-next-hops

    Overlay egress next-hop resources.

    Egress next-hops are partitioned into overlay and underlay. This counts the utilization of the partition used for overlay.

  • dgpp-module-ids

    DGPP module ID resources.

    DGPPs are an aggregate id consisting of a module_id and a port_id. There are 64 modules and 120 ports per module. Each 'network' ARP entry (IP next-hop) needs a DGPP - the module_id is allocated against the network interface (port) and a port_id is allocated from within the module. A module_id will only be allocated when the first ArpEntry is added (freed when last is removed) but is owned exclusively by that network interface. A network interface may require more than one module_id - i.e. if there are 245 ArpEntries on ethernet-1/1 (possibly spread across multiple network-instance interfaces) then 3 module_ids are required.

  • egress-vlan-translate-egress-vnis

    EGR_VLAN_XLATE_1 resources.

    Corresponds to the 'EGR_VLAN_XLATE_1' HW table (8K entries). These entries are used for finding the egress VNI to be used for VXLAN packets.

  • egress-vlan-translate-local-bias-pairs

    EGR_VLAN_XLATE_2 resources.

    Corresponds to the 'EGR_VLAN_XLATE_2' HW table (24K entries). These entries are used for local bias (ES pruning).

  • level-1-ecmp-groups

    L1 ECMP group resources.

    ECMP FEC resources are divided into L1 ECMP FEC resources and L2 ECMP FEC resources. This counts the number of entries used in the L1 partition.

  • level-2-ecmp-groups

    L2 ECMP group resources.

    ECMP FEC resources are divided into L1 ECMP FEC resources and L2 ECMP FEC resources. This counts the number of entries used in the L2 partition.

  • level-1-ecmp-members

    L1 ECMP member resources.

    ECMP FEC member resources are divided into L1 and L2 resources. This counts the number of entries used in the L1 partition.

  • level-2-ecmp-members

    L2 ECMP member resources.

    ECMP FEC member resources are divided into L1 and L2 resources. This counts the number of entries used in the L2 partition.

  • level-1-non-ecmp-fecs

    L1 non-ECMP FEC resources.

    Non-ECMP FEC resources are divided into L1 and L2 resources. This counts the number of entries used in the L1 partition.

  • level-2-non-ecmp-fecs

    L2 non-ECMP FEC resources.

    Non-ECMP FEC resources are divided into L1 and L2 resources. This counts the number of entries used in the L2 partition.

ConfigurableTrue
PlatformsSupported on all platforms
falling-threshold-log number
Description Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the datapath resource in any linecard (if applicable) or forwarding complex or pipeline (if applicable) reaches this value in a falling direction
Contextplatform resource-monitoring datapath asic resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
PlatformsSupported on all platforms
rising-threshold-log number
Description Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the datapath resource in any linecard (if applicable) or forwarding complex or pipeline (if applicable) reaches this value in a rising direction
Contextplatform resource-monitoring datapath asic resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
PlatformsSupported on all platforms
xdp
Description Container for monitoring datapath resources that are generic in concept.
Contextplatform resource-monitoring datapath xdp
Treexdp
ConfigurableTrue
PlatformsSupported on all platforms
resource name identityref
Description List of generic datapath resources
Context platform resource-monitoring datapath xdp resource name identityref
Treeresource
ConfigurableTrue
PlatformsSupported on all platforms
name identityref
Description

The name of the XDP datapath resource.

Some of these resources may be software only (i.e. no correspondence to a hardware table).

Some of these resources may depend on multiple HW tables and when the utilization is reported it represents an aggregated or summarized view.

Contextplatform resource-monitoring datapath xdp resource name identityref
Options

  • arp-nd-entries

    IPv4 ARP and IPv6 neighbor discovery resources.

    Each IPv4 ARP and each IPv6 neighbor entry counts as 1 used resource against a total that is platform dependent. This does not consider underlying ASIC resources.

  • ip-hosts

    IP host route resources.

    Trident3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. In non-ALPM operation every remote /32 route also requires 1 entry. Every local host /128 route, and ND entry requires 2 entries. In non-ALPM operation every remote /128 route also requires 2 entries. Free entries reflects the total number of entries remaining in shared + dedicated UFT banks

    Trident4 and Tomahawk3: Reports the number of entries used in the IP host table. Every local host /32 route, ARP entry and IPv4 subnet broadcast address requires 1 entry. Every local host /128 route, and ND entry requires 2 entries.

  • ip-lpm-routes

    IP longest prefix match route resources.

    Jericho2: Every installed IPv4 and IPv6 route counts as one used route.

    Trident3 and Tomahawk3: In ALPM-disabled mode: Reports the number of half-wide entries. An IPv4 route requires a half-wide entry. An IPv6 route that is /64 or less requires a single-wide entry (2 half-wide entries). An IPv6 route that is more than /64 requires a double-wide entry (4 half-wide entries). In ALPM mode: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 2 used routes.

    Trident4: Every IPv4 route counts as 1 used route and every IPv6 route (regardless of prefix length) counts as 4 used routes.

  • mac-addresses

    MAC address resources.

    Reports the number of entries used in the MAC lookup table. On TD3, free entries reflects the total number of entries remaining in shared + dedicated UFT banks

  • direct-next-hops

    Direct next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP or MPLS route that is resolved directly to a local interface. This does not consider underlying ASIC resources.

  • indirect-next-hops

    Indirect next-hop resources.

    Reports the number of entries, where 1 entry is used for every next-hop of an IP route that is resolved by a non-local route. This does not consider underlying ASIC resources.

  • tunnel-next-hops

    Tunnel next-hop resources.

    Reports the number of tunnel next-hop entries. For EVPN routes resolved by VXLAN, 1 entry is used for every <vni, vtep> pair. When a BGP IP route is resolved by an MPLS tunnel, 1 entry is used for every BGP next-hop of the route. This does not consider underlying ASIC resources.

  • ecmp-groups

    ECMP group resources.

    Jericho2: Reports the used number of ECMP FECs, adding L1 ECMP FECs and L2 ECMP FECs.

    Trident3: Reports the used number of ECMP groups, adding overlay and underlay ECMP groups.

    Trident4 and Tomahawk3: Reports used number of ECMP groups.

  • ecmp-members

    ECMP member resources.

    Jericho2: Reports the used number of ECMP member FECs, adding L1 ECMP member FECs and L2 ECMP member FECs.

    Trident3: Reports the used number of ECMP members, adding overlay and underlay ECMP members.

    Trident4 and Tomahawk3: Reports used number of ECMP members.

  • egress-next-hops

    Egress next-hop resources.

    Trident3: Reports the number of entries used in the egress next-hop table, counting entries in the overlay partition and entries in the underlay partition. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

    Trident4 and Tomahawk3: Reports the number of entries used in the egress next-hop table. 1 entry = 1 IPv4 next-hop address or 1 IPv6 next-hop address.

  • lag-groups

    LAG group resources.

    Reports the number of LAG resources used, including DGPP LAGs.

  • lag-members

    LAG member resources.

    Reports the number of LAG member resources used, including DGPP LAG members.

  • subinterfaces

    Subinterface resources.

    There are a maximum of 127 subinterfaces per TH3 pipeline (limited by VFP/EFP TCAM resources). This counts the utilization of those resources.

  • mpls-next-hops

    One resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an ILM entry that performs a 'swap'. One additional resource is used for every next-hop that pushes an MPLS label in every next-hop-group that is tied to an MPLS tunnel.

  • mpls-incoming-labels

    One resource is used for every MPLS ILM entry that performs either a 'swap' or a 'pop' operation.

  • tunnels

    Tunnel resources. One tunnel resource is used per VXLAN or MPLS tunnel endpoint.

    On TD3 and TD4 systems this equates to a DVP resource.

ConfigurableTrue
PlatformsSupported on all platforms
falling-threshold-log number
Description Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the datapath resource in any linecard (if applicable) or forwarding complex or pipeline (if applicable) reaches this value in a falling direction
Contextplatform resource-monitoring datapath xdp resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
PlatformsSupported on all platforms
rising-threshold-log number
Description Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the datapath resource in any linecard (if applicable) or forwarding complex or pipeline (if applicable) reaches this value in a rising direction
Contextplatform resource-monitoring datapath xdp resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
PlatformsSupported on all platforms

mtu

Description Enter the mtu context
Context platform resource-monitoring mtu
Treemtu
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
resource name identityref
Description Enter the resource list instance
Context platform resource-monitoring mtu resource name identityref
Treeresource
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
name identityref
Description The name of the MTU resource
Context platform resource-monitoring mtu resource name identityref
Options

  • ip-mtu

    IP MTU resource pool. One resource from this pool is consumed by every different IP MTU value used by the subinterfaces on the linecard forwarding-complex.

  • port-mtu

    Port MTU resource pool. One resource from this pool is consumed by every different port MTU value used by a port on the linecard forwarding-complex.

  • mpls-mtu

    MPLS MTU resource pool. One resource from this pool is consumed by every different MPLS MTU value used by the subinterfaces on the linecard forwarding-complex.

ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
falling-threshold-log number
Description Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the MTU resource in any linecard/complex/core reaches this value in a falling direction and this is the first trigger since the last rising-threshold-log was triggered.
Contextplatform resource-monitoring mtu resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
rising-threshold-log number
Description Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the MTU resource in any linecard/complex/core reaches this value in a rising direction and this is the first trigger since the last restart or since the last falling-threshold-log was triggered.
Contextplatform resource-monitoring mtu resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

qos

Description Enter the qos context
Context platform resource-monitoring qos
Treeqos
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
resource name identityref
Description Enter the resource list instance
Context platform resource-monitoring qos resource name identityref
Treeresource
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
name identityref
Description The name of the QoS resource
Context platform resource-monitoring qos resource name identityref
Options

  • classifier-profiles

    A classifier-profile resource is used every time a different combination of IPv4 DSCP classifier and IPv6 DSCP classifier is applied to an ingress subinterface of the 7250 IXR IMM. There are 16 of these resources and one is always used by the combination of the default IPv4 DSCP classifier and the default IPv6 DSCP classifier.

  • rewrite-profiles

    On the 7250 IXR, a rewrite-profile resource is used every time a different combination of IPv4 DSCP rewrite-rule and IPv6 DSCP rewrite-rule is applied to an egress subinterface of the 7250 IXR IMM. There are 32 of these resources.

  • rewrite-policies

    A rewrite-policy resource is used every time a different DSCP or MPLS traffic-class rewrite-rule policy is applied to an egress subinterface of the 7250 IXR IMM. There are 32 of these resources.

ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
falling-threshold-log number
Description Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the QoS resource in any linecard/complex/core falls reaches this value in a falling direction
Contextplatform resource-monitoring qos resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6
rising-threshold-log number
Description Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the QoS resource in any linecard/complex/core reaches this value in a rising direction
Contextplatform resource-monitoring qos resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6

tcam

Description Enter the tcam context
Context platform resource-monitoring tcam
Treetcam
ConfigurableTrue
PlatformsSupported on all platforms
resource name identityref
Description Enter the resource list instance
Context platform resource-monitoring tcam resource name identityref
Treeresource
ConfigurableTrue
PlatformsSupported on all platforms
name identityref
Description The name of the TCAM resource
Context platform resource-monitoring tcam resource name identityref
Options

  • if-input-ipv4

    Resource pool of TCAM entries used by IPv4 ACLs applied as subinterface-input filers

  • if-output-ipv4

    Resource pool of TCAM entries used by IPv4 ACLs applied as subinterface-output filers

  • if-input-ipv6

    Resource pool of TCAM entries used by IPv6 ACLs applied as subinterface-input filers

  • if-output-ipv6

    Resource pool of TCAM entries used by IPv6 ACLs applied as subinterface-output filers

  • cpm-capture-ipv4

    Resource pool of TCAM entries used by IPv4 cpm-filter ACLs and capture-filter ACLs

  • cpm-capture-ipv6

    Resource pool of TCAM entries used by IPv6 cpm-filter ACLs and capture-filter ACLs

  • system-capture-ipv4

    Resource pool of TCAM entries used by IPv4 capture-filter ACLs and IPv4 system-filter ACLs

  • system-capture-ipv6

    Resource pool of TCAM entries used by IPv6 capture-filter ACLs and IPv6 system-filter ACLs

  • system-capture

    Resource pool of TCAM entries used by IPv4 + IPv6 capture-filter ACLs and system-filter ACLs

  • capture-ipv4

    Resource pool of TCAM entries used by IPv4 capture-filter ACLs

  • capture-ipv6

    Resource pool of TCAM entries used by IPv6 capture-filter ACLs

  • if-output-cpm-ipv4

    Resource pool of TCAM entries used by IPv4 egress ACLs and cpm-filter ACLs

  • if-output-cpm-ipv6

    Resource pool of TCAM entries used by IPv6 egress ACLs and cpm-filter ACLs

  • if-output-cpm

    Resource pool of TCAM entries used by IPv4 + IPv6 egress ACLs and cpm-filter ACLs

  • if-input-mac

    Resource pool of TCAM entries used by MAC ACLs applied as subinterface-input filers

  • if-output-cpm-mac

    Resource pool of TCAM entries used by MAC egress ACLs and MAC cpm-filter ACLs

  • policy-forwarding-ipv4

    Resource pool of TCAM entries used by IPv4 policy-forwarding entries

  • if-input-policer

    Resource pool of TCAM entries used by ingress subinterface policer templates

  • if-input-ipv4-qos

    Resource pool of TCAM entries associated with IPv4 multi-field QoS classification entries, when applied to subinterface input

  • if-input-ipv6-qos

    Resource pool of TCAM entries associated with IPv6 multi-field QoS classification entries, when applied to subinterface input

ConfigurableTrue
PlatformsSupported on all platforms
falling-threshold-log number
Description

Sets the threshold that triggers the generation of a NOTICE log whenever the utilization of the TCAM resource in any linecard/complex/core falls reaches this value in a falling direction.

On platforms that support dynamic TCAM the utilization considers both free-dynamic and free-static.

Contextplatform resource-monitoring tcam resource name identityref falling-threshold-log number
Treefalling-threshold-log
Range0 to 100
Default70
ConfigurableTrue
PlatformsSupported on all platforms
rising-threshold-log number
Description

Sets the threshold that triggers the generation of a WARNING log whenever the utilization of the TCAM resource in any linecard/complex/core reaches this value in a rising direction

On platforms that support dynamic TCAM the utilization considers both free-dynamic and free-static.

Contextplatform resource-monitoring tcam resource name identityref rising-threshold-log number
Treerising-threshold-log
Range0 to 100
Default90
ConfigurableTrue
PlatformsSupported on all platforms