tools system

system
+  aaa
   +  authentication
      +  session id number 
         +  disconnect 
         +  stop 
      +  user username string 
         +  unlock 
   +  authorization
      +  authz-policy
         +  clear 
         +  probe
            +  rpc string
            +  user string
         +  remove 
         +  rotate
            +  created-on number
            +  policy string
            +  version string
+  app-management
   +  application name string 
      +  kill 
      +  quit 
      +  reload 
      +  restart
         +  cold 
         +  warm 
      +  start 
      +  statistics
         +  clear 
      +  stop 
+  boot
   +  fips-140
      +  conditional-test 
   +  golden-image
      +  clear 
      +  image string
+  cgroup
+  configuration
   +  bootconfig
      +  get
         +  boot-config
            +  dynamic-oc-config 
            +  dynamic-vendor-config 
            +  oc-config 
            +  vendor-config 
      +  remove 
      +  set
         +  boot-config
            +  dynamic-oc-config string
            +  dynamic-vendor-config string
            +  oc-config string
            +  vendor-config string
   +  candidate name string 
      +  clear 
   +  checkpoint id (number | checkpoint-name) 
      +  clear 
      +  load 
      +  revert 
   +  confirmed-accept
      +  persist-id string
   +  confirmed-reject
      +  persist-id string
   +  generate-checkpoint
      +  comment string
      +  name string
   +  pathz-policy
      +  clear 
      +  remove 
   +  rescue-clear 
   +  rescue-save 
   +  save 
   +  session id number 
      +  clear 
   +  upgrade
      +  checkpoint id (number | checkpoint-name) 
      +  file string
      +  rescue 
      +  startup 
      +  validation-check keyword
+  dhcp-relay
   +  update-dns-entries 
+  dhcp-server
   +  network-instance name string 
      +  dhcpv4
         +  statistics
            +  clear 
      +  dhcpv6
         +  statistics
            +  clear 
+  dot1x
   +  tunnel
      +  clear 
+  event-handler
   +  instance name string 
      +  reload 
      +  statistics
         +  clear 
+  grpc-server name string 
   +  client id number 
      +  disconnect 
   +  gnoi
      +  containerz
         +  create-volume
            +  driver keyword
            +  label string
            +  mount-option string
            +  mountpoint string
            +  name string
         +  deploy-image
            +  local-path string
            +  name string
            +  tag string
         +  deploy-plugin
            +  local-path string
            +  name string
            +  tag string
         +  remove-container
            +  force boolean
            +  instance-name string
         +  remove-image
            +  force boolean
            +  name string
            +  tag string
         +  remove-plugin
            +  instance-name string
         +  remove-volume
            +  force boolean
            +  name string
         +  start-container
            +  cap-add string
            +  cap-remove string
            +  cmd string
            +  environment string
            +  hard-mem-bytes number
            +  image-name string
            +  instance-name string
            +  label string
            +  max-cpu decimal-number
            +  network string
            +  ports internal number 
               +  external number
            +  restart-attempts number
            +  restart-policy keyword
            +  run-as-group string
            +  run-as-user string
            +  soft-mem-bytes number
            +  tag string
            +  volume name string 
               +  mount-point string
               +  read-only boolean
         +  start-plugin
            +  config string
            +  instance-name string
            +  name string
         +  stop-container
            +  force boolean
            +  instance-name string
            +  restart boolean
         +  stop-plugin
            +  instance-name string
      +  healthz
         +  chassis
            +  clear 
         +  clear 
         +  control
            +  clear 
            +  slot string
         +  fabric
            +  clear 
            +  slot number
         +  fan-tray
            +  clear 
            +  id number
         +  linecard
            +  clear 
            +  forwarding-complex keyword
            +  slot number
         +  power-supply
            +  clear 
            +  id number
         +  transceiver
            +  clear 
            +  interface string
   +  statistics
      +  clear 
+  l2cp-transparency
   +  efm-oam
      +  clear 
   +  elmi
      +  clear 
   +  esmc
      +  clear 
   +  l2cp-total-statistics
      +  clear 
   +  lacp
      +  clear 
   +  lldp
      +  clear 
   +  ptp
      +  clear 
   +  xstp
      +  clear 
+  lldp
   +  interface name string 
      +  statistics
         +  clear 
   +  statistics
      +  clear 
+  mirroring
   +  mirroring-instance name string 
      +  mirror-destination
         +  statistics
            +  clear 
+  netconf-server name string 
   +  session session-id number 
      +  clear 
      +  statistics
         +  clear 
   +  statistics
      +  clear 
+  network-instance
   +  protocols
      +  mgmt-stp name string 
         +  bpdu-guard-error
            +  clear 
         +  interface interface-name string 
            +  bpdu-guard-error
               +  clear 
            +  statistics
               +  clear 
         +  statistics
            +  clear 
+  packet-trace-base64
   +  interface string
   +  packet binary
+  restore-sd
   +  current 
+  snmp
   +  trap trap-name string 
      +  force 
      +  network-instance string
      +  trigger string
      +  value string
+  sync
   +  gnss
      +  restart-position-survey 
   +  ptp
      +  instance instance-index number 
         +  clear-statistics 
         +  default-ds
            +  freq-recovery-engine
               +  statistics
                  +  clear 
            +  statistics
               +  clear 
            +  time-recovery-engine
               +  statistics
                  +  clear 
         +  inactive-peers
            +  clear 
         +  port-ds-configured-peer port-index number 
            +  statistics
               +  clear 
         +  port-ds-discovered-peer port-index number 
            +  statistics
               +  clear 
         +  port-ds-interface port-index number 
            +  statistics
               +  clear 
         +  port-ds-sync0
            +  clear-statistics 
            +  port sync0-id keyword 
               +  statistics
                  +  clear 
         +  recovery-engine
            +  reset 
+  tls
   +  generate-csr
      +  common-name string
      +  country string
      +  domain-names string
      +  email string
      +  ip-addresses (ipv4-address | ipv6-address)
      +  key-size number
      +  key-type keyword
      +  locality string
      +  organization string
      +  organization-unit string
      +  spiffe-id string
      +  state string
      +  type keyword
   +  generate-self-signed
      +  common-name string
      +  country string
      +  domain-names string
      +  duration number
      +  email string
      +  ip-addresses (ipv4-address | ipv6-address)
      +  key-size number
      +  key-type keyword
      +  locality string
      +  organization string
      +  organization-unit string
      +  spiffe-id string
      +  state string
      +  type keyword
   +  profile name string 
      +  certz
         +  remove 
         +  rotate
            +  certificate string
            +  created-on number
            +  crl string
            +  key string
            +  trust-anchor string
            +  use-tpm-devid keyword
            +  version string
+  transceiver
   +  firmware
      +  abort-transfer
         +  all-interfaces 
         +  interface string
      +  activate
         +  action keyword
         +  all-interfaces 
         +  interface string
         +  no-commit 
      +  commit-running
         +  all-interfaces 
         +  interface string
      +  transfer
         +  all-interfaces 
         +  file string
         +  interface string
         +  package string

system Descriptions

system

Description Enclosing container for system management.
Contextsystem
Treesystem
ConfigurableTrue
PlatformsSupported on all platforms

aaa

Description Top-level container for operational commands related to AAA
Contextsystem aaa
Treeaaa
ConfigurableTrue
PlatformsSupported on all platforms

authentication

Description

Enter the authentication context

Operational commands related to authentication

Contextsystem aaa authentication
Treeauthentication
ConfigurableTrue
PlatformsSupported on all platforms
session id number
Description List of active sessions in the system
Contextsystem aaa authentication session id number
Treesession
ConfigurableTrue
PlatformsSupported on all platforms
stop
Description Stop the aaa session, the process belonging to the session will be terminated gracefully
Contextsystem aaa authentication session id number stop
Treestop
ConfigurableTrue
PlatformsSupported on all platforms
user username string
Description List of local users including admin and linuxadmin
Contextsystem aaa authentication user username string
Treeuser
ConfigurableTrue
PlatformsSupported on all platforms

authorization

Description

Enter the authorization context

Operational commands relating to authorization

Contextsystem aaa authorization
Treeauthorization
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
authz-policy
Description Top-level container for operational commands relating to Authz gRPC policies
Contextsystem aaa authorization authz-policy
Treeauthz-policy
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear Authz authorization policy counters
Contextsystem aaa authorization authz-policy clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
probe
Description

Perform a test against the current policy

Both a user and rpc must be provided.

Contextsystem aaa authorization authz-policy probe
Treeprobe
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
rpc string
Description

The RPC to test access to as the provided user

This follows the gNSI gRPC path format, in that it is /<pkg>.<service>/<rpc>, for example /gnmi.gNMI/Get.

Contextsystem aaa authorization authz-policy probe rpc string
Treerpc
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
user string
Description

The user to test the current policy with

This can be either a SPIFFE URI or username.

Contextsystem aaa authorization authz-policy probe user string
Treeuser
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove
Description

Remove Authz authorization policy from the system

Since there is only a single system-wide gRPC authorization policy, it will revert its contents to the factory default authorization policy which authorizes any gRPC calls for every user.

Contextsystem aaa authorization authz-policy remove
Treeremove
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
rotate
Description Perform a rotation of the Authz gRPC policy
Contextsystem aaa authorization authz-policy rotate
Treerotate
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
created-on number
Description

Sets the created on value for the new policy

Value is the number of seconds since the epoch. For reference the current time from the epoch in most Linux distributions can be retrieved via 'date +%s'. You can also select a specific date via 'date -d "2023-03-31" +%s'.

If no value is provided the systems current date and time is used.

Contextsystem aaa authorization authz-policy rotate created-on number
Treecreated-on
Unitsseconds
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
policy string
Description

Contains the gRPC authorization policy as a JSON-formatted string

For example: { "name": "Default policy", "allow_rules": [{ "name": "admin-access", "source": { "principals": [ "admin" ] }, "request": { "paths": [ "/*" ] } }] }

Contextsystem aaa authorization authz-policy rotate policy string
Treepolicy
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
version string
Description

A version string to store with the policy

No constraints are applied other than the value must be a string.

If no value is provided no default is used.

Contextsystem aaa authorization authz-policy rotate version string
Treeversion
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

app-management

Description Operational commands related to app-management
Contextsystem app-management
Treeapp-management
ConfigurableTrue
PlatformsSupported on all platforms

application name string

Description List of all applications managed by the application manager
Contextsystem app-management application name string
Treeapplication
ConfigurableTrue
PlatformsSupported on all platforms
restart
Description

Restart the application instance

The best restart that is supported by the application is used if neither 'warm' or 'cold' is specified. If 'warm' restart is supported that will be used, or 'cold' if 'warm' is unavailable.

A 'warm' restart will result in the application leaving its state in IDB during the restart, and recovering it post restart. This restart type results in less disruption to surrounding applications that would depend on the restarting applications state.

A 'cold' restart will result in a normal stop/start of the application, including the purging of its state in IDB.

Contextsystem app-management application name string restart
Treerestart
ConfigurableTrue
PlatformsSupported on all platforms

boot

Description Top-level container for operational commands related to booting the system
Contextsystem boot
Treeboot
ConfigurableTrue
PlatformsSupported on all platforms

fips-140

Description

Enter the fips-140 context

Operational state and commands related to FIPS 140 cryptographic module validation.

Contextsystem boot fips-140
Treefips-140
ConfigurableTrue
PlatformsSupported on all platforms
conditional-test
Description

Execute an on-demand Conditional Self-Test (CST) to verify the current operational health and compliance of the FIPS module.

Invoking this command triggers a cryptographic operation (e.g., ECDSA key generation) that forces the module to run the Pairwise Consistency Test (PCT) and the Continuous Random Number Generator Test (CRNGT). The command returns success only if the FIPS provider is loaded, functional, and passes these critical runtime checks.

Contextsystem boot fips-140 conditional-test
Treeconditional-test
ConfigurableTrue
PlatformsSupported on all platforms

golden-image

Description

Enter the golden-image context

Container for operational commands related to golden image

Contextsystem boot golden-image
Treegolden-image
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Unset the golden-image
Context system boot golden-image clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
image string
Description

Sets the golden image the system uses

This command selects an image to act as a golden-image to which the system reverts when a factory reset operation is requested.

Contextsystem boot golden-image image string
Treeimage
String Length1 to 255
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

cgroup

Description Top-level container for query commands related to cgroup in the system
Contextsystem cgroup
Treecgroup
ConfigurableTrue
PlatformsSupported on all platforms

configuration

Description Top-level container for operational commands related to the system configuration
Contextsystem configuration
Treeconfiguration
ConfigurableTrue
PlatformsSupported on all platforms

bootconfig

Description

Enter the bootconfig context

gNOI BootConfig tools commands

Contextsystem configuration bootconfig
Treebootconfig
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
get
Description

Enter the get context

Get BootConfig data

Contextsystem configuration bootconfig get
Treeget
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
boot-config
Description The boot config data to get
Context system configuration bootconfig get boot-config
Treeboot-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
dynamic-oc-config
Description The dynamic openconfig specific boot configuration data
Contextsystem configuration bootconfig get boot-config dynamic-oc-config
Treedynamic-oc-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
dynamic-vendor-config
Description The dynamic vendor specific boot configuration data
Contextsystem configuration bootconfig get boot-config dynamic-vendor-config
Treedynamic-vendor-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
oc-config
Description The openconfig specific boot configuration data
Contextsystem configuration bootconfig get boot-config oc-config
Treeoc-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
vendor-config
Description The vendor specific boot configuration data
Contextsystem configuration bootconfig get boot-config vendor-config
Treevendor-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove
Description Remove all BootConfig data from the system
Contextsystem configuration bootconfig remove
Treeremove
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
set
Description

Enter the set context

Set BootConfig data

Contextsystem configuration bootconfig set
Treeset
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
boot-config
Description The boot config data to set
Context system configuration bootconfig set boot-config
Treeboot-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
dynamic-oc-config string
Description The dynamic openconfig specific boot configuration data
Contextsystem configuration bootconfig set boot-config dynamic-oc-config string
Treedynamic-oc-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
dynamic-vendor-config string
Description The dynamic vendor specific boot configuration data
Contextsystem configuration bootconfig set boot-config dynamic-vendor-config string
Treedynamic-vendor-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
oc-config string
Description The openconfig specific boot configuration data
Contextsystem configuration bootconfig set boot-config oc-config string
Treeoc-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
vendor-config string
Description The vendor specific boot configuration data
Contextsystem configuration bootconfig set boot-config vendor-config string
Treevendor-config
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

candidate name string

Description List of configuration candidates currently active
Contextsystem configuration candidate name string
Treecandidate
ConfigurableTrue
PlatformsSupported on all platforms
name string
Description The name of the candidate
Context system configuration candidate name string
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
clear
Description

Clear the candidate from the system, discarding any changes

This results in any users currently in the candidate being dropped back to running mode.

Contextsystem configuration candidate name string clear
Treeclear
ConfigurableTrue
PlatformsSupported on all platforms

checkpoint id (number | checkpoint-name)

Description List of current checkpoints present in the system
Contextsystem configuration checkpoint id (number | checkpoint-name)
Treecheckpoint
ConfigurableTrue
PlatformsSupported on all platforms
id (number | checkpoint-name)
Description System generated ID, or operator defined name for the checkpoint
Contextsystem configuration checkpoint id (number | checkpoint-name)
ConfigurableTrue
PlatformsSupported on all platforms
load
Description Load candidate from saved checkpoint configuration
Contextsystem configuration checkpoint id (number | checkpoint-name) load
Treeload
ConfigurableTrue
PlatformsSupported on all platforms
revert
Description

Revert running system configuration to the saved checkpoint configuration

This functions as a load and commit action.

Contextsystem configuration checkpoint id (number | checkpoint-name) revert
Treerevert
ConfigurableTrue
PlatformsSupported on all platforms

generate-checkpoint

Description Generate a checkpoint point based on the current running configuration
Contextsystem configuration generate-checkpoint
Treegenerate-checkpoint
ConfigurableTrue
PlatformsSupported on all platforms

pathz-policy

Description Top-level container for operational commands relating to Pathz gRPC policies
Contextsystem configuration pathz-policy
Treepathz-policy
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear Pathz authorization policy counters
Contextsystem configuration pathz-policy clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove
Description Remove Pathz authorization policy from the system
Contextsystem configuration pathz-policy remove
Treeremove
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

rescue-save

Description Save current running configuration as rescue configuration - rescue-config.json
Contextsystem configuration rescue-save
Treerescue-save
ConfigurableTrue
PlatformsSupported on all platforms

save

Description Save current running configuration as initial (startup) configuration - config.json
Contextsystem configuration save
Treesave
ConfigurableTrue
PlatformsSupported on all platforms

session id number

Description List of configuration sessions currently active
Contextsystem configuration session id number
Treesession
ConfigurableTrue
PlatformsSupported on all platforms
id number
Description System generated ID for the configuration session
Contextsystem configuration session id number
ConfigurableTrue
PlatformsSupported on all platforms
clear
Description Clear the session from the system, discarding any changes
Contextsystem configuration session id number clear
Treeclear
ConfigurableTrue
PlatformsSupported on all platforms

upgrade

Description Operational commands related to configuration upgrade
Contextsystem configuration upgrade
Treeupgrade
ConfigurableTrue
PlatformsSupported on all platforms
checkpoint id (number | checkpoint-name)
Description List of configuration checkpoints
Context system configuration upgrade checkpoint id (number | checkpoint-name)
Treecheckpoint
ConfigurableTrue
PlatformsSupported on all platforms
id (number | checkpoint-name)
Description System generated ID, or operator defined name for the checkpoint
Contextsystem configuration upgrade checkpoint id (number | checkpoint-name)
ConfigurableTrue
PlatformsSupported on all platforms
file string
Description System file path to a json configuration file
Contextsystem configuration upgrade file string
Treefile
ConfigurableTrue
PlatformsSupported on all platforms
validation-check keyword
Description

Specifies the kind of validation that will be executed after the content is upgraded

If the validation fails the upgraded content will not be persisted.

Contextsystem configuration upgrade validation-check keyword
Treevalidation-check
Defaultreplace
Options
  • skip

    Skip validation of the upgraded content

  • merge

    Validation is done as if the content was used in a load merge operation

  • replace

    Validation is done as if the content was used in a full config replace operation

ConfigurableTrue
PlatformsSupported on all platforms

dhcp-relay

Description Enable the dhcp-relay context
Context system dhcp-relay
Treedhcp-relay
ConfigurableTrue
PlatformsSupported on all platforms

update-dns-entries

Description

Update all dhcp-relay server domain name resolutions

A server host entry that cannot be resolved will be unavailable until it can be successfully resolved.

Contextsystem dhcp-relay update-dns-entries
Treeupdate-dns-entries
ConfigurableTrue
PlatformsSupported on all platforms

dhcp-server

Description Enable the dhcp-server context
Context system dhcp-server
Treedhcp-server
ConfigurableTrue
PlatformsSupported on all platforms

network-instance name string

Description List of network instances to run a dhcp server in
Contextsystem dhcp-server network-instance name string
Treenetwork-instance
ConfigurableTrue
PlatformsSupported on all platforms
dhcpv4
Description Enter the dhcpv4 context
Context system dhcp-server network-instance name string dhcpv4
Treedhcpv4
ConfigurableTrue
PlatformsSupported on all platforms
dhcpv6
Description Enter the dhcpv6 context
Context system dhcp-server network-instance name string dhcpv6
Treedhcpv6
ConfigurableTrue
PlatformsSupported on all platforms

dot1x

Description Enclosing container for tools system dot1x
Contextsystem dot1x
Treedot1x
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

tunnel

Description Enclosing container for tools system dot1x tunnel
Contextsystem dot1x tunnel
Treetunnel
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for interface and system level 802.1x.
Contextsystem dot1x tunnel clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

event-handler

Description Top-level container for operational commands on event handler and event handling instances
Contextsystem event-handler
Treeevent-handler
ConfigurableTrue
PlatformsSupported on all platforms

instance name string

Description List of all event handler instances
Context system event-handler instance name string
Treeinstance
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements20
name string
Description A user-defined name for this event handler instance
Contextsystem event-handler instance name string
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms

grpc-server name string

Description List of configured gRPC server instances
Contextsystem grpc-server name string
Treegrpc-server
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

name string

Description User-provided name of this server instance
Contextsystem grpc-server name string
String Length1 to 255
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

client id number

Description List of active gRIBI client sessions
Context system grpc-server name string client id number
Treeclient
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
id number
Description System generated ID for for the client
Contextsystem grpc-server name string client id number
Range0 to 4294967295
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
disconnect
Description Disconnect this client from the server
Contextsystem grpc-server name string client id number disconnect
Treedisconnect
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

gnoi

Description Top-level container for operational commands related to gNOI
Contextsystem grpc-server name string gnoi
Treegnoi
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
containerz
Description

Enter the containerz context

gNOI Containerz tools commands

Contextsystem grpc-server name string gnoi containerz
Treecontainerz
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
create-volume
Description

Create a persistent volume for container use

A volume is backed by persistent storage and is expected to exist across device reboots.

Contextsystem grpc-server name string gnoi containerz create-volume
Treecreate-volume
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
driver keyword
Description

The volume driver to use

If not specified, defaults to the standard Linux mount driver.

Contextsystem grpc-server name string gnoi containerz create-volume driver keyword
Treedriver
Options
  • local

    Standard mount(8) built-in volume driver

  • custom

    Custom volume driver loaded via Plugin RPCs

ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
label string
Description

Labels to apply to the volume

Each entry should be in KEY=VALUE format. Labels are metadata for the volume.

Contextsystem grpc-server name string gnoi containerz create-volume label string
Treelabel
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
mount-option string
Description

Mount options for the local driver

Options as specified by mount(8).

Contextsystem grpc-server name string gnoi containerz create-volume mount-option string
Treemount-option
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
mountpoint string
Description The mount point for the local driver
Context system grpc-server name string gnoi containerz create-volume mountpoint string
Treemountpoint
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name of the volume to create
Context system grpc-server name string gnoi containerz create-volume name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
deploy-image
Description

Deploy a container image from a local file path

The image file must be a valid container image archive (e.g. tar). Upon successful deployment, the image is loaded into the container runtime registry.

Contextsystem grpc-server name string gnoi containerz deploy-image
Treedeploy-image
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
local-path string
Description The local file path of the container image archive to deploy
Contextsystem grpc-server name string gnoi containerz deploy-image local-path string
Treelocal-path
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description

The name to assign to the container image

If not specified, the name is derived from the image archive.

Contextsystem grpc-server name string gnoi containerz deploy-image name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
tag string
Description

The tag (version) to assign to the container image

If not specified, the tag is derived from the image archive.

Contextsystem grpc-server name string gnoi containerz deploy-image tag string
Treetag
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
deploy-plugin
Description

Deploy a plugin from a local file path

The plugin file must be a valid plugin archive (e.g. tar). Upon successful deployment, the plugin is saved until StartPlugin is called.

Contextsystem grpc-server name string gnoi containerz deploy-plugin
Treedeploy-plugin
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
local-path string
Description The local file path of the plugin archive to deploy
Contextsystem grpc-server name string gnoi containerz deploy-plugin local-path string
Treelocal-path
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name to assign to the plugin
Context system grpc-server name string gnoi containerz deploy-plugin name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
tag string
Description The tag (version) to assign to the plugin
Contextsystem grpc-server name string gnoi containerz deploy-plugin tag string
Treetag
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove-container
Description

Remove a container from the system

The container must be stopped unless force is specified.

Contextsystem grpc-server name string gnoi containerz remove-container
Treeremove-container
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
force boolean
Description If true, forcibly remove the container even if it is running
Contextsystem grpc-server name string gnoi containerz remove-container force boolean
Treeforce
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description The name of the container instance to remove
Contextsystem grpc-server name string gnoi containerz remove-container instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove-image
Description

Remove a container image from the system

If the image is associated with a running container, an error is returned.

Contextsystem grpc-server name string gnoi containerz remove-image
Treeremove-image
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
force boolean
Description If true, forcibly remove the image
Context system grpc-server name string gnoi containerz remove-image force boolean
Treeforce
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name of the container image to remove
Contextsystem grpc-server name string gnoi containerz remove-image name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
tag string
Description The tag of the container image to remove
Contextsystem grpc-server name string gnoi containerz remove-image tag string
Treetag
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove-plugin
Description Remove a plugin from the system
Context system grpc-server name string gnoi containerz remove-plugin
Treeremove-plugin
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description The name of the plugin instance to remove
Contextsystem grpc-server name string gnoi containerz remove-plugin instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove-volume
Description Remove a volume from the system
Context system grpc-server name string gnoi containerz remove-volume
Treeremove-volume
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
force boolean
Description If true, forcibly remove the volume
Context system grpc-server name string gnoi containerz remove-volume force boolean
Treeforce
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name of the volume to remove
Context system grpc-server name string gnoi containerz remove-volume name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
start-container
Description

Start a container from a specified image

If the image does not exist on the target, an error is returned. An instance name can optionally be provided, otherwise the target assigns one.

Contextsystem grpc-server name string gnoi containerz start-container
Treestart-container
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
cap-add string
Description

Linux capabilities to add to the container

Valid capabilities can be found in capabilities(7).

Contextsystem grpc-server name string gnoi containerz start-container cap-add string
Treecap-add
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
cap-remove string
Description Linux capabilities to remove from the container
Contextsystem grpc-server name string gnoi containerz start-container cap-remove string
Treecap-remove
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
cmd string
Description The command to run inside the container
Contextsystem grpc-server name string gnoi containerz start-container cmd string
Treecmd
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
environment string
Description

Environment variables to set in the container

Each entry should be in KEY=VALUE format.

Contextsystem grpc-server name string gnoi containerz start-container environment string
Treeenvironment
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
hard-mem-bytes number
Description

Hard memory limit in bytes

If the container exceeds this limit, the container runtime can terminate (OOM kill) the container.

Contextsystem grpc-server name string gnoi containerz start-container hard-mem-bytes number
Treehard-mem-bytes
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
image-name string
Description The name of the container image to start
Contextsystem grpc-server name string gnoi containerz start-container image-name string
Treeimage-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description

The name to give the running container instance

If not specified, the target assigns a name.

Contextsystem grpc-server name string gnoi containerz start-container instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
label string
Description

Labels to apply to the container

Each entry should be in KEY=VALUE format.

Contextsystem grpc-server name string gnoi containerz start-container label string
Treelabel
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
max-cpu decimal-number
Description

Maximum amount of CPU the container can use

For example, 0.5 means this container can use a maximum of half a CPU.

Contextsystem grpc-server name string gnoi containerz start-container max-cpu decimal-number
Treemax-cpu
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
network string
Description

The network to attach this container to

This could be 'host', 'bridged', or any other network available in the runtime.

Contextsystem grpc-server name string gnoi containerz start-container network string
Treenetwork
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
ports internal number
Description List of internal ports to expose outside the container
Contextsystem grpc-server name string gnoi containerz start-container ports internal number
Treeports
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
internal number
Description Internal container port
Context system grpc-server name string gnoi containerz start-container ports internal number
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
external number
Description External host port
Context system grpc-server name string gnoi containerz start-container ports internal number external number
Treeexternal
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
restart-attempts number
Description Maximum restart attempts when restart-policy is on-failure
Contextsystem grpc-server name string gnoi containerz start-container restart-attempts number
Treerestart-attempts
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
restart-policy keyword
Description The restart policy to use for this container
Contextsystem grpc-server name string gnoi containerz start-container restart-policy keyword
Treerestart-policy
Options
  • none

    Never restart the container

  • always

    Always restart the container unless explicitly stopped, including across runtime restarts

  • unless-stopped

    Same as always but not across container runtime restarts

  • on-failure

    Restart on failure for a maximum number of attempts

ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
run-as-group string
Description The group to run the container as
Context system grpc-server name string gnoi containerz start-container run-as-group string
Treerun-as-group
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
run-as-user string
Description The user to run the container as
Context system grpc-server name string gnoi containerz start-container run-as-user string
Treerun-as-user
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
soft-mem-bytes number
Description

Soft memory limit in bytes

If the system is memory constrained, the container may be OOM killed if it exceeds this limit.

Contextsystem grpc-server name string gnoi containerz start-container soft-mem-bytes number
Treesoft-mem-bytes
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
tag string
Description The tag (version) of the container image to start
Contextsystem grpc-server name string gnoi containerz start-container tag string
Treetag
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
volume name string
Description List of volumes to attach to the container
Contextsystem grpc-server name string gnoi containerz start-container volume name string
Treevolume
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name of the volume
Context system grpc-server name string gnoi containerz start-container volume name string
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
mount-point string
Description The mount point inside the container where the volume should be attached
Contextsystem grpc-server name string gnoi containerz start-container volume name string mount-point string
Treemount-point
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
read-only boolean
Description If true, the volume is mounted in read-only mode
Contextsystem grpc-server name string gnoi containerz start-container volume name string read-only boolean
Treeread-only
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
start-plugin
Description Start a previously deployed plugin
Context system grpc-server name string gnoi containerz start-plugin
Treestart-plugin
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
config string
Description The JSON configuration for the plugin
Contextsystem grpc-server name string gnoi containerz start-plugin config string
Treeconfig
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description The name to give the running plugin instance
Contextsystem grpc-server name string gnoi containerz start-plugin instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
name string
Description The name of the plugin as specified during the deploy request
Contextsystem grpc-server name string gnoi containerz start-plugin name string
Treename
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
stop-container
Description

Stop a running container

If the container does not exist or is not running, an error is returned.

Contextsystem grpc-server name string gnoi containerz stop-container
Treestop-container
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
force boolean
Description If true, forcibly kill the container
Context system grpc-server name string gnoi containerz stop-container force boolean
Treeforce
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description The name of the container instance to stop
Contextsystem grpc-server name string gnoi containerz stop-container instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
restart boolean
Description If true, restart the container immediately after stopping it
Contextsystem grpc-server name string gnoi containerz stop-container restart boolean
Treerestart
Defaultfalse
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
stop-plugin
Description Stop a running plugin
Context system grpc-server name string gnoi containerz stop-plugin
Treestop-plugin
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-name string
Description The name of the plugin instance to stop
Contextsystem grpc-server name string gnoi containerz stop-plugin instance-name string
Treeinstance-name
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
healthz
Description

Enter the healthz context

gNOI Healthz tools commands

Contextsystem grpc-server name string gnoi healthz
Treehealthz
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
chassis
Description

Enter the chassis context

Chassis component

Contextsystem grpc-server name string gnoi healthz chassis
Treechassis
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz chassis clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear all healthz events
Context system grpc-server name string gnoi healthz clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
control
Description

Enter the control context

Control module component

Contextsystem grpc-server name string gnoi healthz control
Treecontrol
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz control clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
slot string
Description Slot identifier for the control module
Contextsystem grpc-server name string gnoi healthz control slot string
Treeslot
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
fabric
Description

Enter the fabric context

Fabric module component

Contextsystem grpc-server name string gnoi healthz fabric
Treefabric
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz fabric clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
slot number
Description Numeric identifier for the fabric module
Contextsystem grpc-server name string gnoi healthz fabric slot number
Treeslot
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
fan-tray
Description

Enter the fan-tray context

Fan component

Contextsystem grpc-server name string gnoi healthz fan-tray
Treefan-tray
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz fan-tray clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
id number
Description Numeric identifier for the fan module
Contextsystem grpc-server name string gnoi healthz fan-tray id number
Treeid
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
linecard
Description

Enter the linecard context

Line card component

Clearing a slot component will not clear it's corresponding forwarding-complex components. Similarly, clearing a forwarding-complex component will not clear the slot component.

Contextsystem grpc-server name string gnoi healthz linecard
Treelinecard
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz linecard clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
forwarding-complex keyword
Description individual ASIC (forwarding-complex) component
Contextsystem grpc-server name string gnoi healthz linecard forwarding-complex keyword
Treeforwarding-complex
Options
  • 0

  • 1

Configurable True
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
slot number
Description Numeric identifier for the line card
Context system grpc-server name string gnoi healthz linecard slot number
Treeslot
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
power-supply
Description

Enter the power-supply context

Power supply component

Contextsystem grpc-server name string gnoi healthz power-supply
Treepower-supply
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz power-supply clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
id number
Description Numeric identifier for the power supply module
Contextsystem grpc-server name string gnoi healthz power-supply id number
Treeid
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
transceiver
Description

Enter the transceiver context

Transceiver component

Contextsystem grpc-server name string gnoi healthz transceiver
Treetransceiver
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear healthz events for this component
Contextsystem grpc-server name string gnoi healthz transceiver clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
interface string
Description Interface name for the transceiver module
Contextsystem grpc-server name string gnoi healthz transceiver interface string
Treeinterface
String Length1 to 255
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

statistics

Description

Enter the statistics context

A collection of counters that were collected by the gRPC during the authentication process.

Contextsystem grpc-server name string statistics
Treestatistics
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear gNMI network instance authentication counters
Contextsystem grpc-server name string statistics clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

l2cp-transparency

Description Enable the l2cp-transparency context
Context system l2cp-transparency
Treel2cp-transparency
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

efm-oam

Description Enter the efm-oam context
Context system l2cp-transparency efm-oam
Treeefm-oam
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for the Ethernet in the First Mile OAM protocol
Contextsystem l2cp-transparency efm-oam clear
Treeclear
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

elmi

Description Enter the elmi context
Context system l2cp-transparency elmi
Treeelmi
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for the Ethernet Local Management Interface protocol
Contextsystem l2cp-transparency elmi clear
Treeclear
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

esmc

Description Enter the esmc context
Context system l2cp-transparency esmc
Treeesmc
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for the Ethernet Synchronization Messaging Channel protocol
Contextsystem l2cp-transparency esmc clear
Treeclear
ConfigurableTrue
Platforms7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

l2cp-total-statistics

Description Enter the l2cp-total-statistics context
Contextsystem l2cp-transparency l2cp-total-statistics
Treel2cp-total-statistics
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the global statistics for the L2CP protocols
Contextsystem l2cp-transparency l2cp-total-statistics clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

lacp

Description Enter the lacp context
Context system l2cp-transparency lacp
Treelacp
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for Link Aggregation Control Protocol
Contextsystem l2cp-transparency lacp clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

lldp

Description Enter the lldp context
Context system l2cp-transparency lldp
Treelldp
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for Link Layer Discovery Protocol
Contextsystem l2cp-transparency lldp clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

ptp

Description Enter the ptp context
Context system l2cp-transparency ptp
Treeptp
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for the Precision Time Protocol
Contextsystem l2cp-transparency ptp clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

xstp

Description Enter the xstp context
Context system l2cp-transparency xstp
Treexstp
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears the statistics for all the Spanning Tree Protocols
Contextsystem l2cp-transparency xstp clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H4, 7220 IXR-H4-32D, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

lldp

Description Top-level container for LLDP tools
Context system lldp
Treelldp
ConfigurableTrue
PlatformsSupported on all platforms

interface name string

Description List of interfaces on which LLDP is enabled
Contextsystem lldp interface name string
Treeinterface
ConfigurableTrue
PlatformsSupported on all platforms
name string
Description Reference to a LLDP Ethernet interface
Contextsystem lldp interface name string
ConfigurableTrue
PlatformsSupported on all platforms

statistics

Description

Enter the statistics context

LLDP global statistics tools commands

Contextsystem lldp statistics
Treestatistics
ConfigurableTrue
PlatformsSupported on all platforms

mirroring

Description Enable the mirroring context
Context system mirroring
Treemirroring
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP

mirroring-instance name string

Description Enter the mirroring-instance list instance
Contextsystem mirroring mirroring-instance name string
Treemirroring-instance
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP
name string
Description A unique name identifying the mirroring instance
Contextsystem mirroring mirroring-instance name string
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP
mirror-destination
Description

Enter the mirror-destination context

Mirror destination

Contextsystem mirroring mirroring-instance name string mirror-destination
Treemirror-destination
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP
statistics
Description Enter the statistics context
Context system mirroring mirroring-instance name string mirror-destination statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP
clear
Description Clears the mirror destination statistics
Contextsystem mirroring mirroring-instance name string mirror-destination statistics clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D4, 7220 IXR-D5, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP

netconf-server name string

Description Enter the netconf-server list instance
Contextsystem netconf-server name string
Treenetconf-server
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

name string

Description NETCONF server instance name
Context system netconf-server name string
String Length1 to 247
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

session session-id number

Description Enter the session list instance
Context system netconf-server name string session session-id number
Treesession
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
session-id number
Description Enter the session-id context
Context system netconf-server name string session session-id number
Range1 to 4294967295
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear the NETCONF server instance session
Contextsystem netconf-server name string session session-id number clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system netconf-server name string session session-id number statistics
Treestatistics
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear statistics information for the NETCONF session
Contextsystem netconf-server name string session session-id number statistics clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

statistics

Description Enter the statistics context
Context system netconf-server name string statistics
Treestatistics
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clear statistics information for the NETCONF server instance
Contextsystem netconf-server name string statistics clear
Treeclear
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

network-instance

Description Enclosing container for system network-instance
Contextsystem network-instance
Treenetwork-instance
ConfigurableTrue
PlatformsSupported on all platforms

protocols

Description

Enter the protocols context

Enclosing container for system network-instance protocols

Contextsystem network-instance protocols
Treeprotocols
ConfigurableTrue
PlatformsSupported on all platforms
mgmt-stp name string
Description Management Stp Instance on the system
Contextsystem network-instance protocols mgmt-stp name string
Treemgmt-stp
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
name string
Description mgmt-stp instance name
Context system network-instance protocols mgmt-stp name string
String Length1 to 247
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
bpdu-guard-error
Description Enter the bpdu-guard-error context
Context system network-instance protocols mgmt-stp name string bpdu-guard-error
Treebpdu-guard-error
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
interface interface-name string
Description List of Interfaces managed by Mgmt-Stp
Contextsystem network-instance protocols mgmt-stp name string interface interface-name string
Treeinterface
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
bpdu-guard-error
Description Enter the bpdu-guard-error context
Context system network-instance protocols mgmt-stp name string interface interface-name string bpdu-guard-error
Treebpdu-guard-error
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
statistics
Description Enter the statistics context
Context system network-instance protocols mgmt-stp name string interface interface-name string statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
statistics
Description Enter the statistics context
Context system network-instance protocols mgmt-stp name string statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5

packet-trace-base64

Description Tools command to report the forwarding behavior for a specified test packet (packet specified in base64 format)
Contextsystem packet-trace-base64
Treepacket-trace-base64
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b

interface string

Description References the configured name of the interface in which to inject the probe packet
Contextsystem packet-trace-base64 interface string
Treeinterface
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b

packet binary

Description Packet content encoded in base64 string format
Contextsystem packet-trace-base64 packet binary
Treepacket
ConfigurableTrue
Platforms7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-X1b, 7250 IXR-X3b

restore-sd

Description Top-level container for operational commands related to restoring a SD card
Contextsystem restore-sd
Treerestore-sd
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

current

Description Restore the current active SD card image to the external SD card slot
Contextsystem restore-sd current
Treecurrent
ConfigurableTrue
Platforms7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

snmp

Description Enable the snmp context
Context system snmp
Treesnmp
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS

trap trap-name string

Description Send simulated SNMP trap
Context system snmp trap trap-name string
Treetrap
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS
trap-name string
Description Name of the SNMP trap
Context system snmp trap trap-name string
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS
force
Description Force trap to be send even if value doesn't trigger the python-script to generate a trap
Contextsystem snmp trap trap-name string force
Treeforce
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS
network-instance string
Description

The name of the network instance that will be used to send an SNMP trap.

If none is provided, all possible network-instances will receive the trap

Contextsystem snmp trap trap-name string network-instance string
Treenetwork-instance
String Length1 to 255
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
trigger string
Description

Trigger that will generate the trap with a simulated on-change notification.

Uses xpath format

Context system snmp trap trap-name string trigger string
Treetrigger
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS
value string
Description Value that will be used in the simulated on-change notification
Contextsystem snmp trap trap-name string value string
Treevalue
ConfigurableTrue
PlatformsSupported on all platforms except TOOLS

sync

Description Top-level grouping for sync operational commands
Contextsystem sync
Treesync
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

gnss

Description

Enter the gnss context

Grouping for GNSS operational commands

Contextsystem sync gnss
Treegnss
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

ptp

Description

Enter the ptp context

Grouping for ptp operational commands

Contextsystem sync ptp
Treeptp
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance instance-index number
Description Grouping for PTP instance operational commands
Contextsystem sync ptp instance instance-index number
Treeinstance
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
instance-index number
Description Enter the instance-index context
Context system sync ptp instance instance-index number
Range1 to 10
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear-statistics
Description Clears all PTP statistics for PTP
Context system sync ptp instance instance-index number clear-statistics
Treeclear-statistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
default-ds
Description

Enter the default-ds context

The default data set of the PTP Instance In the context of the protocol, this data set is required for an Ordinary Clock or Boundary Clock

Contextsystem sync ptp instance instance-index number default-ds
Treedefault-ds
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
freq-recovery-engine
Description Enter the freq-recovery-engine context
Contextsystem sync ptp instance instance-index number default-ds freq-recovery-engine
Treefreq-recovery-engine
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number default-ds freq-recovery-engine statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number default-ds statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears PTP statistics and event counters in the default-ds
Contextsystem sync ptp instance instance-index number default-ds statistics clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
time-recovery-engine
Description Enter the time-recovery-engine context
Contextsystem sync ptp instance instance-index number default-ds time-recovery-engine
Treetime-recovery-engine
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number default-ds time-recovery-engine statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
inactive-peers
Description Enter the inactive-peers context
Context system sync ptp instance instance-index number inactive-peers
Treeinactive-peers
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears information related to inactive PTP peers
Contextsystem sync ptp instance instance-index number inactive-peers clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-ds-configured-peer port-index number
Description Grouping for PTP Port DS for configured IP peers operational commands
Contextsystem sync ptp instance instance-index number port-ds-configured-peer port-index number
Treeport-ds-configured-peer
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-index number
Description Enter the port-index context
Context system sync ptp instance instance-index number port-ds-configured-peer port-index number
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number port-ds-configured-peer port-index number statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-ds-discovered-peer port-index number
Description Grouping for PTP Port DS for discovered IP peers operational commands
Contextsystem sync ptp instance instance-index number port-ds-discovered-peer port-index number
Treeport-ds-discovered-peer
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-index number
Description Enter the port-index context
Context system sync ptp instance instance-index number port-ds-discovered-peer port-index number
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number port-ds-discovered-peer port-index number statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-ds-interface port-index number
Description Grouping for PTP Port DS for interfaces operational commands
Contextsystem sync ptp instance instance-index number port-ds-interface port-index number
Treeport-ds-interface
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-index number
Description Enter the port-index context
Context system sync ptp instance instance-index number port-ds-interface port-index number
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number port-ds-interface port-index number statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port-ds-sync0
Description Enter the port-ds-sync0 context
Context system sync ptp instance instance-index number port-ds-sync0
Treeport-ds-sync0
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
port sync0-id keyword
Description Grouping for PTP Port DS for sync0 operational commands
Contextsystem sync ptp instance instance-index number port-ds-sync0 port sync0-id keyword
Treeport
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
sync0-id keyword
Description Enter the sync0-id context
Context system sync ptp instance instance-index number port-ds-sync0 port sync0-id keyword
Options
  • sync0-a

    This may be the sole sync0 port or sync0 port on CPM A in routers with redundant CPMs

  • sync0-b

    Specific states of sync0 port on CPM B in routers with redundant CPMs

ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
statistics
Description Enter the statistics context
Context system sync ptp instance instance-index number port-ds-sync0 port sync0-id keyword statistics
Treestatistics
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
clear
Description Clears all PTP statistics for this sync0
Contextsystem sync ptp instance instance-index number port-ds-sync0 port sync0-id keyword statistics clear
Treeclear
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
recovery-engine
Description Enter the recovery-engine context
Context system sync ptp instance instance-index number recovery-engine
Treerecovery-engine
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
reset
Description Resets the PTP clock algorithm and restarts the recovery process
Contextsystem sync ptp instance instance-index number recovery-engine reset
Treereset
ConfigurableTrue
Platforms7220 IXR-D5, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

tls

Description Top-level container for operational commands related to TLS
Contextsystem tls
Treetls
ConfigurableTrue
PlatformsSupported on all platforms

generate-csr

Description

Generates a certificate signing request and key pair

Fields for the certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination.

Contextsystem tls generate-csr
Treegenerate-csr
ConfigurableTrue
PlatformsSupported on all platforms
common-name string
Description

The common name to use for the certificate signing request

By default the common name is set to the system host name and domain name combination.

Contextsystem tls generate-csr common-name string
Treecommon-name
String Length1 to 64
ConfigurableTrue
PlatformsSupported on all platforms
country string
Description

The country name to use for the certificate signing request

The expected format is two characters long, e.g. 'US'.

Contextsystem tls generate-csr country string
Treecountry
String Length2
DefaultUS
ConfigurableTrue
PlatformsSupported on all platforms
domain-names string
Description

Domain names to add to the SubjectAlternativeName field within the certificate signing request

These names are encoeded as DNS:<name> within the certificate SAN.

Contextsystem tls generate-csr domain-names string
Treedomain-names
String Length1 to 253
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements32
email string
Description The email address to use for the certificate signing request
Contextsystem tls generate-csr email string
Treeemail
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
ip-addresses (ipv4-address | ipv6-address)
Description

IP addresses to add to the SubjectAlternativeName field within the certificate signing request

These addresses are encoded as IP:<ip> within the certificate SAN.

Contextsystem tls generate-csr ip-addresses (ipv4-address | ipv6-address)
Treeip-addresses
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements32
key-size number
Description The size of the private key to generate for the certificate signing request
Contextsystem tls generate-csr key-size number
Treekey-size
Range1024 to 16384
Default4096
ConfigurableTrue
PlatformsSupported on all platforms
key-type keyword
Description The type of private key to generate for the certificate signing request
Contextsystem tls generate-csr key-type keyword
Treekey-type
Defaultrsa
Options
  • rsa

ConfigurableTrue
PlatformsSupported on all platforms
locality string
Description The city or locality to use for the certificate signing request
Contextsystem tls generate-csr locality string
Treelocality
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
organization string
Description The organization to use for the certificate signing request
Contextsystem tls generate-csr organization string
Treeorganization
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
spiffe-id string
Description

A SPIFFE ID to use for the certificate signing request

This ID is in URI form, including the leading 'spiffe://', for example 'spiffe://srlinux.dev/sa/user'.

Contextsystem tls generate-csr spiffe-id string
Treespiffe-id
ConfigurableTrue
PlatformsSupported on all platforms
state string
Description The state or province to use for the certificate signing request
Contextsystem tls generate-csr state string
Treestate
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
type keyword
Description The type of certificate to use for the certificate signing request
Contextsystem tls generate-csr type keyword
Treetype
Defaultx509
Options
  • x509

ConfigurableTrue
PlatformsSupported on all platforms

generate-self-signed

Description

Generates a self signed certificate and key pair

Fields for the self signed certificate are taken from OpenSSL defaults, with the exception of the common name, which is taken from the system host name and domain name combination.

Contextsystem tls generate-self-signed
Treegenerate-self-signed
ConfigurableTrue
PlatformsSupported on all platforms
common-name string
Description

The common name to use for the certificate signing request

By default the common name is set to the system host name and domain name combination.

Contextsystem tls generate-self-signed common-name string
Treecommon-name
String Length1 to 64
ConfigurableTrue
PlatformsSupported on all platforms
country string
Description

The country name to use for the certificate signing request

The expected format is two characters long, e.g. 'US'.

Contextsystem tls generate-self-signed country string
Treecountry
String Length2
DefaultUS
ConfigurableTrue
PlatformsSupported on all platforms
domain-names string
Description

Domain names to add to the SubjectAlternativeName field within the certificate signing request

These names are encoeded as DNS:<name> within the certificate SAN.

Contextsystem tls generate-self-signed domain-names string
Treedomain-names
String Length1 to 253
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements32
duration number
Description The time in which the certificate is valid
Contextsystem tls generate-self-signed duration number
Treeduration
Range1 to 3650
Default365
Unitsdays
Configurable True
PlatformsSupported on all platforms
email string
Description The email address to use for the certificate signing request
Contextsystem tls generate-self-signed email string
Treeemail
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
ip-addresses (ipv4-address | ipv6-address)
Description

IP addresses to add to the SubjectAlternativeName field within the certificate signing request

These addresses are encoded as IP:<ip> within the certificate SAN.

Contextsystem tls generate-self-signed ip-addresses (ipv4-address | ipv6-address)
Treeip-addresses
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements32
key-size number
Description The size of the private key to generate for the certificate signing request
Contextsystem tls generate-self-signed key-size number
Treekey-size
Range1024 to 16384
Default4096
ConfigurableTrue
PlatformsSupported on all platforms
key-type keyword
Description The type of private key to generate for the certificate signing request
Contextsystem tls generate-self-signed key-type keyword
Treekey-type
Defaultrsa
Options
  • rsa

ConfigurableTrue
PlatformsSupported on all platforms
locality string
Description The city or locality to use for the certificate signing request
Contextsystem tls generate-self-signed locality string
Treelocality
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
spiffe-id string
Description

A SPIFFE ID to use for the certificate signing request

This ID is in URI form, including the leading 'spiffe://', for example 'spiffe://srlinux.dev/sa/user'.

Contextsystem tls generate-self-signed spiffe-id string
Treespiffe-id
ConfigurableTrue
PlatformsSupported on all platforms
state string
Description The state or province to use for the certificate signing request
Contextsystem tls generate-self-signed state string
Treestate
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
type keyword
Description The type of certificate to use for the certificate signing request
Contextsystem tls generate-self-signed type keyword
Treetype
Defaultx509
Options
  • x509

ConfigurableTrue
PlatformsSupported on all platforms

profile name string

Description Enter the profile list instance
Context system tls profile name string
Treeprofile
ConfigurableTrue
PlatformsSupported on all platforms
name string
Description Name of the TLS profile
Context system tls profile name string
String Length1 to 247
ConfigurableTrue
PlatformsSupported on all platforms
certz
Description

Enter the certz context

Information relating to the active certificates and bundles as provided via Certz

State is provided by the gNSI Certz service, and can be changed using the gNSI.Certz.Rotate RPC

Contextsystem tls profile name string certz
Treecertz
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
remove
Description Remove Certz SSL profile from the system.
Contextsystem tls profile name string certz remove
Treeremove
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
rotate
Description Perform a rotation of a certificate, trust anchor, or certificate revocation list within Certz SSL profile.
Contextsystem tls profile name string certz rotate
Treerotate
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
certificate string
Description

Base64 encoded certificate to use with the provided or existing private key

This includes the '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' header and footer

Contextsystem tls profile name string certz rotate certificate string
Treecertificate
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
created-on number
Description

Sets the created on value for the new policy

Value is the number of seconds since the epoch. For reference the current time from the epoch in most Linux distributions can be retrieved via 'date +%s'. You can also select a specific date via 'date -d "2023-03-31" +%s'.

If no value is provided the systems current date and time is used.

Contextsystem tls profile name string certz rotate created-on number
Treecreated-on
Unitsseconds
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
crl string
Description Base64 encoded bundle of certificates to add to the certificate revocation list
Contextsystem tls profile name string certz rotate crl string
Treecrl
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
key string
Description

Base64 encoded key to use with the certificate

This includes the '-----BEGIN PRIVATE KEY-----', and '-----END PRIVATE KEY-----' header and footer

The value is hashed, and only the hashed value is kept

Contextsystem tls profile name string certz rotate key string
Treekey
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
trust-anchor string
Description Base64 encoded certificate chain to use as a trust anchor
Contextsystem tls profile name string certz rotate trust-anchor string
Treetrust-anchor
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
use-tpm-devid keyword
Description Defines if the TLS profile key and certificate uses the TPM idevid or oidevid
Contextsystem tls profile name string certz rotate use-tpm-devid keyword
Treeuse-tpm-devid
Options
  • idevid

    The TPM iDevID key and certificate is used

  • oidevid

    The TPM iDevID key and oIDevID certificate is used

ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
version string
Description

A version string to store with the policy

No constraints are applied other than the value must be a string.

If no value is provided no default is used.

Contextsystem tls profile name string certz rotate version string
Treeversion
ConfigurableTrue
Platforms7215 IXS-A1, 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O, 7220 IXR-H5-64O-512, 7220 IXR-H6-64, 7250 IXR-10, 7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3, 7250 IXR-X1b, 7250 IXR-X3b, 7250 IXR-X4, 7250 IXR-X4-OSFP, 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S

transceiver

Description Tools related to transceivers
Context system transceiver
Treetransceiver
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3

firmware

Description

Enter the firmware context

Tools related to transceiver firmware

Contextsystem transceiver firmware
Treefirmware
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
abort-transfer
Description Abort the current transfer operation active on one or more transceivers
Contextsystem transceiver firmware abort-transfer
Treeabort-transfer
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
interface string
Description

The list of interfaces with transceivers to be included in the operation

Current support restricts the list to a maximum of one interface.

Contextsystem transceiver firmware abort-transfer interface string
Treeinterface
String Length1 to 255
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
Max. Elements1
Min. Elements1
activate
Description Activate firmware
Context system transceiver firmware activate
Treeactivate
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
action keyword
Description Specifies the specific activation action to be performed
Contextsystem transceiver firmware activate action keyword
Treeaction
Options
  • switch-to-inactive-bank

  • switch-hitless-to-inactive-bank

  • restart-active-bank

  • restart-hitless-active-bank

ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
all-interfaces
Description Enter the all-interfaces context
Context system transceiver firmware activate all-interfaces
Treeall-interfaces
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
interface string
Description

The list of interfaces with transceivers to be included in the operation

Current support restricts the list to a maximum of one interface.

Contextsystem transceiver firmware activate interface string
Treeinterface
String Length1 to 255
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
Max. Elements1
Min. Elements1
no-commit
Description If specified, committed bank is not changed
Contextsystem transceiver firmware activate no-commit
Treeno-commit
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
commit-running
Description Commit the active bank on one or more transceivers
Contextsystem transceiver firmware commit-running
Treecommit-running
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
interface string
Description

The list of interfaces with transceivers to be included in the operation

Current support restricts the list to a maximum of one interface.

Contextsystem transceiver firmware commit-running interface string
Treeinterface
String Length1 to 255
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
Max. Elements1
Min. Elements1
transfer
Description

Initiate a transfer of a new image into one or more transceivers

Only one transfer operation can be active at a time.

Contextsystem transceiver firmware transfer
Treetransfer
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
all-interfaces
Description Enter the all-interfaces context
Context system transceiver firmware transfer all-interfaces
Treeall-interfaces
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
file string
Description

File containing an image

This is used for a traditional distribution of images as binary files containing only the entire block of data to be transferred to the transceiver.

Contextsystem transceiver firmware transfer file string
Treefile
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
interface string
Description

The list of interfaces with transceivers to be included in the operation

Current support restricts the list to a maximum of one interface.

Contextsystem transceiver firmware transfer interface string
Treeinterface
String Length1 to 255
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3
Max. Elements1
Min. Elements1
package string
Description

File containing a package of images including metadata headers

This is used for packages as defined by OIF XXX. It is expected to be .tgz format that needs extraction. The package by target transceiver to select the newest image for that transceiver based on vendor and vendor part number.

Contextsystem transceiver firmware transfer package string
Treepackage
ConfigurableTrue
Platforms7250 IXR-10e-gen2cp, 7250 IXR-10e-gen2cp-3, 7250 IXR-10e-gen3, 7250 IXR-18e-gen3, 7250 IXR-6e-gen2cp, 7250 IXR-6e-gen2cp-3, 7250 IXR-6e-gen3