tools platform

platform
+  chassis
   +  reboot
      +  cancel 
      +  delay number
      +  force 
      +  message string
      +  warm
         +  force
         +  validate
+  control slot string 
   +  locator
      +  disable 
      +  enable
         +  duration number
   +  reboot
      +  cancel 
      +  delay number
      +  force 
      +  message string
+  fabric slot number 
   +  locator
      +  disable 
      +  enable
         +  duration number
   +  reboot
      +  cancel 
      +  delay number
      +  message string
+  fan-tray id number 
   +  locator
      +  disable 
      +  enable
         +  duration number
+  linecard slot number 
   +  locator
      +  disable 
      +  enable
         +  duration number
   +  reboot
      +  cancel 
      +  delay number
      +  message string
+  redundancy
   +  switchover
   +  synchronize
      +  overlay 
      +  system 
+  show-fabric-bandwidth 
+  trust
   +  attestation
      +  control slot string 
         +  log-retrieval
            +  bios
               +  display
                  +  from number
                  +  pcr number
                  +  to number
               +  summary 
            +  ima
               +  display
                  +  from number
                  +  pcr number
                  +  to number
               +  summary 
         +  pcr-quote
            +  nonce binary
            +  pcr-selection string
   +  secure-boot
      +  control slot string 
         +  activate
            +  confirmation-code string
            +  serial-number string
         +  revoke
            +  confirmation-code string
            +  serial-number string
         +  update
            +  confirmation-code string
            +  serial-number string

platform Descriptions

platform

Description Top-level container for platform operational commands
Contextplatform
Treeplatform
ConfigurableTrue
PlatformsSupported on all platforms

chassis

Description Operational commands related to the chassis
Contextplatform chassis
Treechassis
ConfigurableTrue
PlatformsSupported on all platforms

reboot

Description Trigger a reboot of the chassis
Context platform chassis reboot
Treereboot
ConfigurableTrue
PlatformsSupported on all platforms
delay number
Description

The amount of time to delay the reboot

During this period, the reboot can be cancelled.

Contextplatform chassis reboot delay number
Treedelay
Unitsseconds
ConfigurableTrue
PlatformsSupported on all platforms
force
Description

Force a reboot of this component, overriding any synchronizations or other activities in progress

This option can be dangerous, and may result in a module booting on an older image if used after an image change

Contextplatform chassis reboot force
Treeforce
ConfigurableTrue
PlatformsSupported on all platforms
message string
Description A user-defined message to broadcoast to other users of the system
Contextplatform chassis reboot message string
Treemessage
ConfigurableTrue
PlatformsSupported on all platforms
warm
Description

Perform a warm reboot of the system

This option will perform checks against the current configuration, before prompting to confirm the reboot, and then rebooting the system without impacting the datapath - if a new image has been configured, this will upgrade the system.

Contextplatform chassis reboot warm
Treewarm
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L
force
Description

Force a warm reboot of the system, overriding any validation, synchronizations or other activities in progress

This option can be dangerous, and may result in an outage - but can be used to support a fast reboot of the system.

Contextplatform chassis reboot warm force
Treeforce
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L
validate
Description Validate that the system's current configuration and state supports a warm reboot operation
Contextplatform chassis reboot warm validate
Treevalidate
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L

control slot string

Description Operational commands related to control modules
Contextplatform control slot string
Treecontrol
ConfigurableTrue
PlatformsSupported on all platforms

slot string

Description Slot identifier for the control module
Contextplatform control slot string
ConfigurableTrue
PlatformsSupported on all platforms

locator

Description Operational commands for the locator LED
Contextplatform control slot string locator
Treelocator
ConfigurableTrue
PlatformsSupported on all platforms
enable
Description Activate the locator LED for this component
Contextplatform control slot string locator enable
Treeenable
ConfigurableTrue
PlatformsSupported on all platforms
duration number
Description Sets the duration to activate the locator LED, after which it will disable automatically
Contextplatform control slot string locator enable duration number
Treeduration
Range10 to 3600
Unitsseconds
ConfigurableTrue
PlatformsSupported on all platforms

reboot

Description Trigger or a reboot of this component
Contextplatform control slot string reboot
Treereboot
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
cancel
Description Cancels a pending reboot on this component
Contextplatform control slot string reboot cancel
Treecancel
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
delay number
Description

The amount of time to delay the reboot

During this period, the reboot can be cancelled.

Contextplatform control slot string reboot delay number
Treedelay
Unitsseconds
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
force
Description

Force a reboot of this component, overriding any synchronizations or other activities in progress

This option can be dangerous, and may result in a module booting on an older image if used after an image change

Contextplatform control slot string reboot force
Treeforce
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
message string
Description A user-defined message to broadcoast to other users of the system
Contextplatform control slot string reboot message string
Treemessage
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

fabric slot number

Description Operational commands related to fabric modules
Contextplatform fabric slot number
Treefabric
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

slot number

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

locator

Description Operational commands for the locator LED
Contextplatform fabric slot number locator
Treelocator
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
disable
Description Deactivates the locator LED for this component
Contextplatform fabric slot number locator disable
Treedisable
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
enable
Description Activate the locator LED for this component
Contextplatform fabric slot number locator enable
Treeenable
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
duration number
Description Sets the duration to activate the locator LED, after which it will disable automatically
Contextplatform fabric slot number locator enable duration number
Treeduration
Range10 to 3600
Unitsseconds
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

reboot

Description Trigger or a reboot of this component
Contextplatform fabric slot number reboot
Treereboot
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
cancel
Description Cancels a pending reboot on this component
Contextplatform fabric slot number reboot cancel
Treecancel
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
delay number
Description

The amount of time to delay the reboot

During this period, the reboot can be cancelled.

Contextplatform fabric slot number reboot delay number
Treedelay
Unitsseconds
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
message string
Description A user-defined message to broadcoast to other users of the system
Contextplatform fabric slot number reboot message string
Treemessage
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

fan-tray id number

Description Operational commands related to fan modules
Contextplatform fan-tray id number
Treefan-tray
ConfigurableTrue
PlatformsSupported on all platforms

id number

Description Numeric identifier for the fan module
Contextplatform fan-tray id number
ConfigurableTrue
PlatformsSupported on all platforms

locator

Description Operational commands for the locator LED
Contextplatform fan-tray id number locator
Treelocator
ConfigurableTrue
PlatformsSupported on all platforms
enable
Description Activate the locator LED for this component
Contextplatform fan-tray id number locator enable
Treeenable
ConfigurableTrue
PlatformsSupported on all platforms
duration number
Description Sets the duration to activate the locator LED, after which it will disable automatically
Contextplatform fan-tray id number locator enable duration number
Treeduration
Range10 to 3600
Unitsseconds
ConfigurableTrue
PlatformsSupported on all platforms

linecard slot number

Description Operational commands related to line cards
Contextplatform linecard slot number
Treelinecard
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

slot number

Description Numeric identifier for the line card
Context platform linecard slot number
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

locator

Description Operational commands for the locator LED
Contextplatform linecard slot number locator
Treelocator
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
disable
Description Deactivates the locator LED for this component
Contextplatform linecard slot number locator disable
Treedisable
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
enable
Description Activate the locator LED for this component
Contextplatform linecard slot number locator enable
Treeenable
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
duration number
Description Sets the duration to activate the locator LED, after which it will disable automatically
Contextplatform linecard slot number locator enable duration number
Treeduration
Range10 to 3600
Unitsseconds
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

reboot

Description Trigger or a reboot of this component
Contextplatform linecard slot number reboot
Treereboot
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
cancel
Description Cancels a pending reboot on this component
Contextplatform linecard slot number reboot cancel
Treecancel
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
delay number
Description

The amount of time to delay the reboot

During this period, the reboot can be cancelled.

Contextplatform linecard slot number reboot delay number
Treedelay
Unitsseconds
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
message string
Description A user-defined message to broadcoast to other users of the system
Contextplatform linecard slot number reboot message string
Treemessage
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

redundancy

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

switchover

Description Trigger a redundancy switchover to the other control module
Contextplatform redundancy switchover
Treeswitchover
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

synchronize

Description Top-level container for manual synchronization activies
Contextplatform redundancy synchronize
Treesynchronize
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
overlay
Description

Force a synchronization of the overlay filesystem between the active control module and the standby

This synchronizes all non-excluded directories in the overlay filesystem

Contextplatform redundancy synchronize overlay
Treeoverlay
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e
system
Description

Force a synchronization of the system-required data between the active control module and the standby

This synchronizes images, configuration, checkpoints, and other system-required data

Contextplatform redundancy synchronize system
Treesystem
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e

trust

Description Operational commands related to Platform Trust
Contextplatform trust
Treetrust
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b

attestation

Description Tools commands input parameter for attestation to retrieve TCG BIOS Logs, IMA Logs
Contextplatform trust attestation
Treeattestation
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
control slot string
Description Operational commands related to log retrieval for control modules
Contextplatform trust attestation control slot string
Treecontrol
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
slot string
Description Slot identifier for the control module
Contextplatform trust attestation control slot string
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
log-retrieval
Description Tools commands to retrieve BIOS and IMA Log
Contextplatform trust attestation control slot string log-retrieval
Treelog-retrieval
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
bios
Description TCG BIOS log retrieval commands
Context platform trust attestation control slot string log-retrieval bios
Treebios
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
display
Description Enter the display context
Context platform trust attestation control slot string log-retrieval bios display
Treedisplay
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
ima
Description IMA log retrieval commands
Context platform trust attestation control slot string log-retrieval ima
Treeima
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
display
Description Enter the display context
Context platform trust attestation control slot string log-retrieval ima display
Treedisplay
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
pcr-quote
Description Tools commands input parameter to retrieve TPM PCR Quote This container includes every information element defined in the reference challenge-response interaction model for remote attestation. Corresponding values are based on TPM 2.0 structure definitions
Contextplatform trust attestation control slot string pcr-quote
Treepcr-quote
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
nonce binary
Description A random number intended to guarantee freshness and for use as part of a replay-detection mechanism Note that a nonce sent into a TPM will typically be 160 or 256 binary digits long (20 or 32 bytes) If fewer binary digits are sent, this nonce object will be padded with leading zeros within Quotes returned from the TPM. Additionally if more bytes are sent, the nonce will be trimmed to the most significant binary digits
Contextplatform trust attestation control slot string pcr-quote nonce binary
Treenonce
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b

secure-boot

Description Secure Boot operational commands
Context platform trust secure-boot
Treesecure-boot
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
control slot string
Description Operational commands related Secure Boot for control modules
Contextplatform trust secure-boot control slot string
Treecontrol
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
slot string
Description Slot identifier for the control module
Contextplatform trust secure-boot control slot string
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
activate
Description Activate Secure Boot
Context platform trust secure-boot control slot string activate
Treeactivate
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
revoke
Description Update UEFI Secure Boot forbidden database (dbx), Key Exchange Key (KEK), Platform Key (PK)
Contextplatform trust secure-boot control slot string revoke
Treerevoke
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b
update
Description Update UEFI Secure Boot authorized database (db), Key Exchange Key (KEK), Platform Key (PK)
Contextplatform trust secure-boot control slot string update
Treeupdate
ConfigurableTrue
Platforms7250 IXR-10e, 7250 IXR-6e, 7250 IXR-X3b