system

system
+  aaa
   +  accounting
      +  accounting-method reference
      +  event event-type identityref
         +  record identityref
   +  authentication
      +  admin-user
         +  password string
         -  username string
      +  authentication-method reference
      +  exit-on-reject boolean
      +  idle-timeout number
      -  session id number
         -  authentication-method string
         -  login-time string
         -  priv-lvl number
         -  remote-host string
         -  service-name string
         -  tty-name string
         -  username string
      +  user username string
         +  password string
         +  role reference
         +  ssh-key string
   +  authorization
      +  role rolename string
         +  tacacs
            +  priv-lvl number
   +  server-group name string
      +  priv-lvl-authorization boolean
      +  server address (ipv4-address | ipv6-address)
         +  name string
         +  network-instance reference
         -  oper-state keyword
         -  statistics
            -  accounting-connection-failures number
            -  accounting-rejects number
            -  accounting-success number
            -  authorization-connection-failures number
            -  authorization-rejects number
            -  authorization-success number
            -  login-connection-failures number
            -  login-rejects number
            -  login-success number
         +  tacacs
            +  port number
            +  secret-key string
      +  timeout number
      +  type identityref
-  app-management
   -  application name string
      -  author string
      -  cgroup string
      -  failure-action string
      -  failure-threshold number
      -  failure-window number
      -  last-change string
      -  launch-command string
      -  oom-score-adj number
      -  path string
      -  pid number
      -  restricted-operations keyword
      -  search-command string
      -  state keyword
      -  statistics
         -  restart-count number
      -  version string
      -  yang
         -  modules string
         -  source-directories string
+  authentication
   +  keychain name string
      +  admin-state keyword
      +  description string
      +  key index number
         +  algorithm keyword
         +  authentication-key string
      +  type keyword
+  banner
   +  login-banner string
   +  motd-banner string
+  boot
   +  autoboot
      +  admin-state keyword
      +  attempts number
      +  client-id keyword
      +  interface reference
      -  oper-state string
      +  timeout number
   -  image string
+  bridge-table
   +  mac-learning
      -  mac-relearn-only boolean
   +  mac-limit
      -  maximum-entries number
      -  warning-threshold-pct number
   -  statistics
      -  active-entries number
      -  failed-entries number
      -  mac-type type keyword
         -  active-entries number
         -  failed-entries number
         -  total-entries number
      -  total-entries number
+  clock
   +  timezone keyword
+  configuration
   +  auto-checkpoint boolean
   -  candidate name string
      -  started string
      -  type keyword
      -  username string
   -  checkpoint id number
      -  comment string
      -  created string
      -  name string
      -  size number
      -  tag string
      -  username string
      -  version string
   -  commit id number
      -  comment string
      -  ended string
      -  name string
      -  started string
      -  status keyword
      -  type keyword
      -  username string
   +  idle-timeout number
   -  last-change string
   +  max-candidates number
   +  max-checkpoints number
   +  role name reference
      +  rule path-reference string
         +  action keyword
   -  session id number
      -  exclusive boolean
      -  name string
      -  started string
      -  type keyword
      -  username string
+  dhcp-server
   +  admin-state keyword
   +  network-instance name reference
      +  dhcpv4
         +  admin-state keyword
         -  oper-state keyword
         +  options
            +  bootfile-name string
            +  dns-server string
            +  domain-name string
            +  hostname string
            +  ntp-server string
            +  router string
            +  server-id string
         +  static-allocation
            +  host mac string
               +  ip-address string
               +  options
                  +  bootfile-name string
                  +  dns-server string
                  +  domain-name string
                  +  hostname string
                  +  ntp-server string
                  +  router string
                  +  server-id string
         -  statistics
            -  client-packets-discarded number
            -  client-packets-received number
            -  server-packets-sent number
         +  trace-options
            +  trace keyword
      +  dhcpv6
         +  admin-state keyword
         -  oper-state keyword
         +  options
            +  dns-server string
         +  static-allocation
            +  host mac string
               +  ip-address string
               +  options
                  +  dns-server string
         -  statistics
            -  client-packets-discarded number
            -  client-packets-received number
            -  server-packets-sent number
         +  trace-options
            +  trace keyword
+  dns
   +  host-entry name string
      +  ipv4-address string
      +  ipv6-address string
   +  network-instance reference
   -  oper-state keyword
   +  search-list string
   +  server-list (ipv4-address | ipv6-address)
-  features string
+  ftp-server
   +  network-instance name reference
      +  admin-state keyword
      -  oper-state keyword
      +  session-limit number
      +  source-address (ipv4-address | ipv6-address)
      +  timeout number
+  gnmi-server
   +  admin-state keyword
   +  commit-confirmed-timeout number
   +  commit-save boolean
   +  include-defaults-in-config-only-responses boolean
   +  network-instance name reference
      +  admin-state keyword
      -  oper-state keyword
      +  port number
      +  source-address (ipv4-address | ipv6-address)
      +  tls-profile reference
      +  use-authentication boolean
   +  rate-limit number
   +  session-limit number
   -  subscription id number
      -  mode keyword
      -  paths string
      -  remote-host (ipv4-address | ipv6-address)
      -  remote-port number
      -  sample-interval number
      -  start-time string
      -  user string
      -  user-agent string
   +  timeout number
   +  trace-options keyword
   +  unix-socket
      +  admin-state keyword
      -  oper-state keyword
      -  socket-path string
      +  tls-profile reference
      +  use-authentication boolean
+  information
   +  contact string
   -  current-datetime string
   -  description string
   -  last-booted string
   +  location string
   -  version string
+  json-rpc-server
   +  admin-state keyword
   +  commit-confirmed-timeout number
   +  network-instance name reference
      +  http
         +  admin-state keyword
         -  oper-state keyword
         +  port number
         +  session-limit number
         +  source-address (ipv4-address | ipv6-address)
         +  use-authentication boolean
      +  https
         +  admin-state keyword
         -  oper-state keyword
         +  port number
         +  session-limit number
         +  source-address (ipv4-address | ipv6-address)
         +  tls-profile reference
         +  use-authentication boolean
   +  trace-options keyword
   +  unix-socket
      +  admin-state keyword
      -  oper-state keyword
      -  socket-path string
      +  tls-profile reference
      +  use-authentication boolean
+  lacp
   +  system-id string
   +  system-priority number
+  lldp
   +  admin-state keyword
   -  chassis-id string
   -  chassis-id-type keyword
   +  hello-timer number
   +  hold-multiplier number
   +  interface name reference
      +  admin-state keyword
      -  neighbor id string
         -  capability name string
            -  enabled boolean
         -  chassis-id string
         -  chassis-id-type keyword
         -  custom-tlv type number oui string oui-subtype string
            -  value binary
         -  first-message string
         -  last-update string
         -  management-address address string
            -  type keyword
         -  port-description string
         -  port-id (string | binary)
         -  port-id-type keyword
         -  system-description string
         -  system-name string
      -  oper-state keyword
      -  statistics
         -  frame-discard number
         -  frame-error-in number
         -  frame-error-out number
         -  frame-in number
         -  frame-out number
         -  last-clear string
         -  tlv-discard number
         -  tlv-unknown number
   +  management-address subinterface string
      +  type keyword
   -  statistics
      -  entries-aged-out number
      -  frame-discard number
      -  frame-error-in number
      -  frame-in number
      -  frame-out number
      -  last-clear string
      -  tlv-accepted number
      -  tlv-discard number
      -  tlv-unknown number
   -  system-description string
   -  system-name string
   +  trace-options keyword
+  load-balancing
   +  hash-options
      +  destination-address boolean
      +  destination-port boolean
      +  hash-seed number
      +  ipv6-flow-label boolean
      +  mpls-label-stack boolean
      +  protocol boolean
      +  source-address boolean
      +  source-port boolean
      +  vlan boolean
+  logging
   +  buffer buffer-name string
      +  facility facility-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  filter reference
      +  format string
      +  persist number
      +  rotate number
      -  rotations number
      +  size string
      +  subsystem subsystem-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
   +  console
      +  facility facility-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  filter reference
      +  format string
      +  subsystem subsystem-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
   +  file file-name string
      +  directory string
      +  facility facility-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  filter reference
      +  format string
      +  rotate number
      -  rotations number
      +  size string
      +  subsystem subsystem-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
   +  filter filter-name string
      +  contains string
      +  facility facility-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  prefix string
      +  regex string
      +  tag string
   +  network-instance reference
   +  remote-server host (ipv4-address | ipv6-address | domain-name)
      +  facility facility-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  filter reference
      +  remote-port number
      +  subsystem subsystem-name keyword
         +  priority
            +  match-above keyword
            +  match-exact keyword
      +  transport keyword
   +  subsystem-facility keyword
+  maintenance
   +  group name string
      +  maintenance-mode
         +  admin-state keyword
      +  maintenance-profile reference
      +  members
         +  bgp
            +  network-instance name reference
               +  neighbor reference
               +  peer-group reference
         +  isis
            +  network-instances reference
   +  profile name string
      +  bgp
         +  export-policy reference
         +  import-policy reference
      +  isis
         +  overload
            +  max-metric boolean
            +  set-bit boolean
+  mirroring
   +  mirroring-instance name string
      +  admin-state keyword
      +  description string
      +  mirror-destination
         +  local string
      +  mirror-source
         +  interface name string
            +  direction keyword
         +  subinterface name string
            +  direction keyword
      -  oper-down-reason keyword
      -  oper-state keyword
+  mtu
   +  default-ip-mtu number
   +  default-l2-mtu number
   +  default-mpls-mtu number
   +  default-port-mtu number
   +  min-path-mtu number
+  name
   +  domain-name string
   +  host-name string
+  network-instance
   +  protocols
      +  bgp-vpn
         +  bgp-instance id number
            -  oper-down-reason keyword
            +  route-distinguisher
               -  rd (string | string | string | string)
               -  route-distinguisher-origin keyword
            +  route-target
               -  export-route-target-origin keyword
               -  export-rt (string | string | string | string | string | string | string | string | string | string)
               -  import-route-target-origin keyword
               -  import-rt (string | string | string | string | string | string | string | string | string | string)
      +  evpn
         +  ethernet-segments
            +  bgp-instance id reference
               +  ethernet-segment name string
                  +  admin-state keyword
                  -  association
                     -  network-instance name string
                        -  bgp-instance instance number
                           -  computed-designated-forwarder-candidates
                              -  designated-forwarder-candidate address (ipv4-address | ipv6-address)
                                 -  add-time string
                                 -  designated-forwarder boolean
                           -  designated-forwarder-activation-start-time string
                           -  designated-forwarder-activation-time number
                           -  designated-forwarder-role-last-change string
                  -  autodiscovery-per-ethernet-segment-routes
                     -  attr-id reference
                     -  esi string
                     -  ethernet-tag-id number
                     -  neighbor (ipv4-address | ipv6-address)
                     -  route-distinguisher (string | string | string | string)
                     -  vni number
                  +  df-election
                     +  algorithm
                        -  oper-type keyword
                        +  preference-alg
                           +  capabilities
                              +  ac-df keyword
                              +  non-revertive boolean
                           -  oper-do-not-prempt boolean
                           -  oper-preference-value number
                           +  preference-value number
                        +  type keyword
                     +  interface-standby-signaling-on-non-df
                     +  timers
                        +  activation-timer number
                  +  esi string
                  -  ethernet-segment-routes
                     -  attr-id reference
                     -  esi string
                     -  neighbor (ipv4-address | ipv6-address)
                     -  originating-router (ipv4-address | ipv6-address)
                     -  route-distinguisher (string | string | string | string)
                  +  interface reference
                  +  multi-homing-mode keyword
                  -  oper-down-reason keyword
                  -  oper-esi string
                  -  oper-multi-homing-mode keyword
                  -  oper-state keyword
                  +  routes
                     +  ethernet-segment
                        +  originating-ip keyword
                     +  next-hop keyword
            +  timers
               +  activation-timer number
               -  boot-remaining-time number
               -  boot-start-time string
               +  boot-timer number
+  ntp
   +  admin-state keyword
   +  network-instance reference
   -  oper-state keyword
   +  server address (ipv4-address | ipv6-address)
      +  iburst boolean
      -  jitter string
      -  offset string
      -  poll-interval number
      +  prefer boolean
      -  stratum number
   -  synchronized (ipv4-address | ipv6-address | string)
+  ra-guard-policy name string
   +  action keyword
   +  advertise-prefix-set reference
   +  hop-limit number
   +  managed-config-flag boolean
   +  other-config-flag boolean
   +  router-preference keyword
   +  source-prefix-set reference
+  sflow
   +  admin-state keyword
   +  collector collector-id number
      +  collector-address (ipv4-address | ipv6-address)
      +  network-instance reference
      -  next-hop (ipv4-address | ipv6-address)
      +  port number
      +  source-address (ipv4-address | ipv6-address)
   +  sample-rate number
   +  sample-size number
   -  statistics
      -  total-offered-packets number
      -  total-samples-taken number
      -  total-sent-packets number
+  snmp
   +  community string
   +  network-instance name reference
      +  admin-state keyword
      -  oper-state keyword
      +  source-address (ipv4-address | ipv6-address)
+  ssh-server
   +  network-instance name reference
      +  admin-state keyword
      -  oper-state keyword
      -  protocol-version number
      +  rate-limit number
      +  source-address (ipv4-address | ipv6-address)
      +  timeout number
+  tls
   +  server-profile name string
      +  authenticate-client boolean
      +  certificate string
      +  cipher-list identityref
      +  key string
      +  trust-anchor string
+  trace-options keyword
+  warm-reboot
   +  bgp-max-wait number

system Descriptions

system

Description Enclosing container for system management
Contextsystem
Treesystem
ConfigurableTrue

aaa

Description Top-level container for AAA services
Context system aaa
Treeaaa
ConfigurableTrue

event-type identityref

Description The type of activity to record at the accounting server
Contextsystem aaa accounting event event-type identityref
Options
  • command

    Specifies interactive command events for AAA accounting

ConfigurableTrue

record identityref

Description Type of record to send to the accounting server for this activity type
Contextsystem aaa accounting event event-type identityref record identityref
Treerecord
Options
  • start-stop

    Send start and stop records for user activities

    Send start and stop records for user activities A start record is sent to the accounting server at the beginning of the activity, and a stop record at the end of the activity

  • stop

    Send only stop records for user activities

    Send only stop records for user activities A stop record is sent to the accounting server when the user activity completes

ConfigurableTrue

exit-on-reject boolean

Description

Enable/disable exit-on-reject behaviour for authentication attempts

With this behaviour enabled, when a reject is received from any server the system will not try further methods, and will reject the user authentication attempt. Default behaviour is to continue trying methods until one accepts the user, or the system runs out of methods to try.

Contextsystem aaa authentication exit-on-reject boolean
Treeexit-on-reject
Defaultfalse
ConfigurableTrue

idle-timeout number

Description

Set the idle timeout of all CLI sessions

After the timeout is reached, the session is disconnected from the system.

Contextsystem aaa authentication idle-timeout number
Treeidle-timeout
Default600
Unitsseconds
ConfigurableTrue

priv-lvl number

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionTACACS+ authorization priv-lvl (if TACACS+ authorization is enabled)
Contextsystem aaa authentication session id number priv-lvl number
Treepriv-lvl
ConfigurableFalse

role reference

Description

List of roles to assign to this user

The most specific rule for a particular role takes precedence. Rules from all user roles are evaluated together, most permissive privilege taking precedence.

Contextsystem aaa authentication user username string role reference
Treerole
Reference

system aaa authorization role rolename string

ConfigurableTrue
Max. Elements32

ssh-key string

Description

SSH public key(s) for the user (RSA)

If defined, the user may login to the system over SSH with this key. This field includes the 'ssh-rsa' leader, as would normally be found in a SSH key.

Contextsystem aaa authentication user username string ssh-key string
Treessh-key
ConfigurableTrue
Max. Elements32

tacacs

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionTop-level container for configuration relating to TACACS+ interworking with roles
Contextsystem aaa authorization role rolename string tacacs
Treetacacs
ConfigurableTrue

priv-lvl number

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

Description

The TACACS+ priv-lvl to map to this role

All roles matching each specific priv-lvl, and their lessers are merged together to create the final ruleset applied to the user.

Contextsystem aaa authorization role rolename string tacacs priv-lvl number
Treepriv-lvl
Range0 to 15
ConfigurableTrue

server-group name string

Description

List of AAA server-groups in the system

Each server group specifies a type, of which all servers must use. If using the 'local' type, then no servers may be specified.

Contextsystem aaa server-group name string
Treeserver-group
ConfigurableTrue
Max. Elements2

name string

Description User defined name for the server group
Contextsystem aaa server-group name string
String Length1 to 255
ConfigurableTrue

priv-lvl-authorization boolean

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

Description

Use TACACS+ priv-lvl based authorization

If false, then authorization is skipped for TACACS+ users granting full admin access for those users.

Contextsystem aaa server-group name string priv-lvl-authorization boolean
Treepriv-lvl-authorization
Defaultfalse
ConfigurableTrue

server address (ipv4-address | ipv6-address)

Description

List of AAA servers to use within this server-group

Servers are tried in a round-robin fashion, with the first server always being tried if it is operationally available

Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address)
Treeserver
ConfigurableTrue
Max. Elements5

oper-state keyword

Description

Details the operational state of the server

A server is defined as being down if it fails to respond before the timeout period, or if a path towards the server is not available.

Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

timeout number

Description Set the timeout in seconds on responses from servers in this group
Contextsystem aaa server-group name string timeout number
Treetimeout
Range1 to 3600
Default10
Unitsseconds
Configurable True

type identityref

Description AAA server type -- all servers in the group must be of this type
Contextsystem aaa server-group name string type identityref
Treetype
Options
  • tacacs

    Specifies servers using the TACACS+ protocol

    Specifies servers using the TACACS+ protocol Terminal Access Controller Access Control System (TACACS+)

  • local

    Specifies using Linux local methods

    Specifies using Linux local methods This type cannot be combined with a server address

ConfigurableTrue

failure-action string

Description

The action taken after 'failure-threshold' failures within 'failure-window'

This action can be to reboot the system, wait forever, or wait for a predefined number of seconds

Contextsystem app-management application name string failure-action string
Treefailure-action
ConfigurableFalse

restricted-operations keyword

Description The operations that may not be manually performed on this application
Contextsystem app-management application name string restricted-operations keyword
Treerestricted-operations
Options
  • restart

    This application may not be restarted manually

  • stop

    This application may not be stopped manually

  • start

    This application may not be started manually

  • reload

    This application may not be reloaded manually

  • quit

    This application may not be terminated manually

  • kill

    This application may not be terminated ungracefully manually

ConfigurableFalse

state keyword

Description Current state of this application instance
Contextsystem app-management application name string state keyword
Treestate
Options
  • running

    Application instance is running

    Application instance is running This is the normal, active state of an application

  • waiting-for-config

    Application instance is loaded, but has no configuration

    Application instance is loaded, but has no configuration This state requires wait-for-config true within the applications YAML configuration. This results in the application being loaded into app-mgr, but not starting until the system receives configuration for it

  • error

    The application has not started successfully, or has failed

    The application has not started successfully, or has failed This state can be caused by an application hitting the restart backoff, or an application failing to start following triggering a system reboot

  • starting

    The application has been asked to start

    The application has been asked to start All applications enter this state after initial execution, after which application manager will wait five seconds before checking their status. IDB connected applications may announce their state before this five second window has passed, resulting in them transitioning from this state faster than PID-monitored applications.

  • stopped

    The application is not running

    The application is not running This state is most likely caused by an operator action

ConfigurableFalse

admin-state keyword

Description

When set to disable, the keychain is inactive. When a protocol refers to a keychain that is inactive, no authentication data is added to the outbound messages and all inbound messages with authentication data are dropped.

A key chain is also inactive if no key is configured.

Contextsystem authentication keychain name string admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

index number

Description Each key in a keychain requires a unique identifier. The index value specifies this identifier.
Contextsystem authentication keychain name string key index number
ConfigurableTrue

algorithm keyword

Description The cryptographic algorithm used with the keying material to secure the messages.
Contextsystem authentication keychain name string key index number algorithm keyword
Treealgorithm
Options
  • cleartext

    The authentication-key is encoded in plaintext.

  • md5

    The authentication-key is used to generate an MD5 digest (RFC 1321).

  • hmac-md5

    The authentication-key is used to generate a 16-byte (128 bit) MD5 digest using the HMAC algorithm (RFC 2104).

  • hmac-sha-1

    The authentication-key is used to generate a SHA1 digest using the HMAC algorithm (RFC 2104).

  • hmac-sha-256

    The authentication-key is used to generate a SHA2 digest using the HMAC algorithm (RFC 2104).The SHA-256 variant of SHA2 produces an output of 32 bytes (256 bits).

  • aes-128-cmac

    The authentication-key is used with the AES-128 encryption algorithm to generate a cipher MAC (RFC 4493).

ConfigurableTrue

authentication-key string

Description

The secret key.

The maximum string length is 25 characters, of which a maximum of 20 characters is the secret data and the remaining 5 characters, if provided, must be ‘ hash’ (i.e. one whitespace plus the word hash). The trailing ‘hash’ keyword indicates that the secret data was already encrypted and this is the display version of that secret data, which is a hash of the original data. If the ‘hash’ keyword is omitted the string is assumed to be the actual secret data. Whenever the value of authentication-key is read by any management interface, from any datastore (candidate, running, state) the return value is always the encrypted value – i.e. with the trailing ‘ hash’ characters included.

Contextsystem authentication keychain name string key index number authentication-key string
Treeauthentication-key
String Length1 to 25
ConfigurableTrue

type keyword

Description Specifies the intended use of the keychain. The type constrains the set of crypto algorithms that are available to use with each key in the keychain. It is also used ensure that this keychain is only used by protocols for which it is intended.
Contextsystem authentication keychain name string type keyword
Treetype
Options
  • tcp-md5

    Keychain intended to be used for TCP-MD5 authentication.

  • isis

    Keychain intended to be used for authentication of IS-IS PDUs.

  • ospf

    Keychain intended to be used for authentication of OSPFv2 messages.

  • tcp-ao

    Keychain intended to be used for TCP-AO authentication.

  • vrrp

    Keychain intended to be used for authentication of VRRPv2 messages.

ConfigurableTrue

banner

Description Contains configuration and state related to system banners
Contextsystem banner
Treebanner
ConfigurableTrue

boot

Description Top-level container for configuration and state data related to booting the system
Contextsystem boot
Treeboot
ConfigurableTrue

autoboot

Description Top-level container for configuration and state data related to autobooting the system
Contextsystem boot autoboot
Treeautoboot
ConfigurableTrue

attempts number

Description Sets the amount of executions to try autoboot, before rebooting the system
Contextsystem boot autoboot attempts number
Treeattempts
Range1 to 10
ConfigurableTrue

client-id keyword

Description The client ID to use on outgoing DHCP requests
Contextsystem boot autoboot client-id keyword
Treeclient-id
Options
  • serial

    Use the chassis serial number as the client ID

ConfigurableTrue

timeout number

Description Sets the timeout for each attempt to autoboot
Contextsystem boot autoboot timeout number
Treetimeout
Range200 to 3600
Unitsseconds
ConfigurableTrue

image string

Description

Ordered list of local images used to boot the system

This directly translates into boot configuration in grub, where the images are tried in the order specified by the user. Images are sourced via the internal SD card, and the value passed is the folder that contains the initramfs, kernel, and squashfs image. The search path for these directories is /mnt/nokiaos/<folder>

Contextsystem boot image string
Treeimage
String Length1 to 255
ConfigurableFalse
Max. Elements3

type keyword

Description Enter the type context
Context system bridge-table statistics mac-type type keyword
Options
  • static

  • duplicate

  • learnt

  • irb-interface

  • evpn

  • evpn-static

  • irb-interface-anycast

  • proxy-anti-spoof

  • reserved

  • eth-cfm

ConfigurableFalse

clock

Description Top-level container for system clock configuration and state
Contextsystem clock
Treeclock
ConfigurableTrue

timezone keyword

Description The timezone to use for the system Based on IANAs Time Zone database
Contextsystem clock timezone keyword
Treetimezone
Options
  • Africa/Abidjan

  • Africa/Accra

  • Africa/Addis_Ababa

  • Africa/Algiers

  • Africa/Asmara

  • Africa/Bamako

  • Africa/Bangui

  • Africa/Banjul

  • Africa/Bissau

  • Africa/Blantyre

  • Africa/Brazzaville

  • Africa/Bujumbura

  • Africa/Cairo

  • Africa/Casablanca

  • Africa/Ceuta

    Ceuta, Melilla

  • Africa/Conakry

  • Africa/Dakar

  • Africa/Dar_es_Salaam

  • Africa/Djibouti

  • Africa/Douala

  • Africa/El_Aaiun

  • Africa/Freetown

  • Africa/Gaborone

  • Africa/Harare

  • Africa/Johannesburg

  • Africa/Juba

  • Africa/Kampala

  • Africa/Khartoum

  • Africa/Kigali

  • Africa/Kinshasa

    Dem. Rep. of Congo (west)

  • Africa/Lagos

  • Africa/Libreville

  • Africa/Lome

  • Africa/Luanda

  • Africa/Lubumbashi

    Dem. Rep. of Congo (east)

  • Africa/Lusaka

  • Africa/Malabo

  • Africa/Maputo

  • Africa/Maseru

  • Africa/Mbabane

  • Africa/Mogadishu

  • Africa/Monrovia

  • Africa/Nairobi

  • Africa/Ndjamena

  • Africa/Niamey

  • Africa/Nouakchott

  • Africa/Ouagadougou

  • Africa/Porto-Novo

  • Africa/Sao_Tome

  • Africa/Tripoli

  • Africa/Tunis

  • Africa/Windhoek

  • America/Adak

    Aleutian Islands

  • America/Anchorage

    Alaska (most areas)

  • America/Anguilla

  • America/Antigua

  • America/Araguaina

    Tocantins

  • America/Argentina/Buenos_Aires

    Buenos Aires (BA, CF)

  • America/Argentina/Catamarca

    Catamarca (CT); Chubut (CH)

  • America/Argentina/Cordoba

    Argentina (most areas: CB, CC, CN, ER, FM, MN, SE, SF)

  • America/Argentina/Jujuy

    Jujuy (JY)

  • America/Argentina/La_Rioja

    La Rioja (LR)

  • America/Argentina/Mendoza

    Mendoza (MZ)

  • America/Argentina/Rio_Gallegos

    Santa Cruz (SC)

  • America/Argentina/Salta

    Salta (SA, LP, NQ, RN)

  • America/Argentina/San_Juan

    San Juan (SJ)

  • America/Argentina/San_Luis

    San Luis (SL)

  • America/Argentina/Tucuman

    Tucuman (TM)

  • America/Argentina/Ushuaia

    Tierra del Fuego (TF)

  • America/Aruba

  • America/Asuncion

  • America/Atikokan

    EST - ON (Atikokan); NU (Coral H)

  • America/Bahia

    Bahia

  • America/Bahia_Banderas

    Central Time - Bahia de Banderas

  • America/Barbados

  • America/Belem

    Para (east); Amapa

  • America/Belize

  • America/Blanc-Sablon

    AST - QC (Lower North Shore)

  • America/Boa_Vista

    Roraima

  • America/Bogota

  • America/Boise

    Mountain - ID (south); OR (east)

  • America/Cambridge_Bay

    Mountain - NU (west)

  • America/Campo_Grande

    Mato Grosso do Sul

  • America/Cancun

    Eastern Standard Time - Quintana Roo

  • America/Caracas

  • America/Cayenne

  • America/Cayman

  • America/Chicago

    Central (most areas)

  • America/Chihuahua

    Mountain Time - Chihuahua (most areas)

  • America/Costa_Rica

  • America/Creston

    MST - BC (Creston)

  • America/Cuiaba

    Mato Grosso

  • America/Curacao

  • America/Danmarkshavn

    National Park (east coast)

  • America/Dawson

    Pacific - Yukon (north)

  • America/Dawson_Creek

    MST - BC (Dawson Cr, Ft St John)

  • America/Denver

    Mountain (most areas)

  • America/Detroit

    Eastern - MI (most areas)

  • America/Dominica

  • America/Edmonton

    Mountain - AB; BC (E); SK (W)

  • America/Eirunepe

    Amazonas (west)

  • America/El_Salvador

  • America/Fort_Nelson

    MST - BC (Ft Nelson)

  • America/Fortaleza

    Brazil (northeast: MA, PI, CE, RN, PB)

  • America/Glace_Bay

    Atlantic - NS (Cape Breton)

  • America/Godthab

    Greenland (most areas)

  • America/Goose_Bay

    Atlantic - Labrador (most areas)

  • America/Grand_Turk

  • America/Grenada

  • America/Guadeloupe

  • America/Guatemala

  • America/Guayaquil

    Ecuador (mainland)

  • America/Guyana

  • America/Halifax

    Atlantic - NS (most areas); PE

  • America/Havana

  • America/Hermosillo

    Mountain Standard Time - Sonora

  • America/Indiana/Indianapolis

    Eastern - IN (most areas)

  • America/Indiana/Knox

    Central - IN (Starke)

  • America/Indiana/Marengo

    Eastern - IN (Crawford)

  • America/Indiana/Petersburg

    Eastern - IN (Pike)

  • America/Indiana/Tell_City

    Central - IN (Perry)

  • America/Indiana/Vevay

    Eastern - IN (Switzerland)

  • America/Indiana/Vincennes

    Eastern - IN (Da, Du, K, Mn)

  • America/Indiana/Winamac

    Eastern - IN (Pulaski)

  • America/Inuvik

    Mountain - NT (west)

  • America/Iqaluit

    Eastern - NU (most east areas)

  • America/Jamaica

  • America/Juneau

    Alaska - Juneau area

  • America/Kentucky/Louisville

    Eastern - KY (Louisville area)

  • America/Kentucky/Monticello

    Eastern - KY (Wayne)

  • America/Kralendijk

  • America/La_Paz

  • America/Lima

  • America/Los_Angeles

    Pacific

  • America/Lower_Princes

  • America/Maceio

    Alagoas, Sergipe

  • America/Managua

  • America/Manaus

    Amazonas (east)

  • America/Marigot

  • America/Martinique

  • America/Matamoros

    Central Time US - Coahuila, Nuevo Leon, Tamaulipas (US border)

  • America/Mazatlan

    Mountain Time - Baja California Sur, Nayarit, Sinaloa

  • America/Menominee

    Central - MI (Wisconsin border)

  • America/Merida

    Central Time - Campeche, Yucatan

  • America/Metlakatla

    Alaska - Annette Island

  • America/Mexico_City

    Central Time

  • America/Miquelon

  • America/Moncton

    Atlantic - New Brunswick

  • America/Monterrey

    Central Time - Durango; Coahuila, Nuevo Leon, Tamaulipas (most areas)

  • America/Montevideo

  • America/Montserrat

  • America/Nassau

  • America/New_York

    Eastern (most areas)

  • America/Nipigon

    Eastern - ON, QC (no DST 1967-73)

  • America/Nome

    Alaska (west)

  • America/Noronha

    Atlantic islands

  • America/North_Dakota/Beulah

    Central - ND (Mercer)

  • America/North_Dakota/Center

    Central - ND (Oliver)

  • America/North_Dakota/New_Salem

    Central - ND (Morton rural)

  • America/Ojinaga

    Mountain Time US - Chihuahua (US border)

  • America/Panama

  • America/Pangnirtung

    Eastern - NU (Pangnirtung)

  • America/Paramaribo

  • America/Phoenix

    MST - Arizona (except Navajo)

  • America/Port-au-Prince

  • America/Port_of_Spain

  • America/Porto_Velho

    Rondonia

  • America/Puerto_Rico

  • America/Punta_Arenas

    Region of Magallanes

  • America/Rainy_River

    Central - ON (Rainy R, Ft Frances)

  • America/Rankin_Inlet

    Central - NU (central)

  • America/Recife

    Pernambuco

  • America/Regina

    CST - SK (most areas)

  • America/Resolute

    Central - NU (Resolute)

  • America/Rio_Branco

    Acre

  • America/Santarem

    Para (west)

  • America/Santiago

    Chile (most areas)

  • America/Santo_Domingo

  • America/Sao_Paulo

    Brazil (southeast: GO, DF, MG, ES, RJ, SP, PR, SC, RS)

  • America/Scoresbysund

    Scoresbysund/Ittoqqortoormiit

  • America/Sitka

    Alaska - Sitka area

  • America/St_Barthelemy

  • America/St_Johns

    Newfoundland; Labrador (southeast)

  • America/St_Kitts

  • America/St_Lucia

  • America/St_Thomas

  • America/St_Vincent

  • America/Swift_Current

    CST - SK (midwest)

  • America/Tegucigalpa

  • America/Thule

    Thule/Pituffik

  • America/Thunder_Bay

    Eastern - ON (Thunder Bay)

  • America/Tijuana

    Pacific Time US - Baja California

  • America/Toronto

    Eastern - ON, QC (most areas)

  • America/Tortola

  • America/Vancouver

    Pacific - BC (most areas)

  • America/Whitehorse

    Pacific - Yukon (south)

  • America/Winnipeg

    Central - ON (west); Manitoba

  • America/Yakutat

    Alaska - Yakutat

  • America/Yellowknife

    Mountain - NT (central)

  • Antarctica/Casey

    Casey

  • Antarctica/Davis

    Davis

  • Antarctica/DumontDUrville

    Dumont-d'Urville

  • Antarctica/Macquarie

    Macquarie Island

  • Antarctica/Mawson

    Mawson

  • Antarctica/McMurdo

    New Zealand time - McMurdo, South Pole

  • Antarctica/Palmer

    Palmer

  • Antarctica/Rothera

    Rothera

  • Antarctica/Syowa

    Syowa

  • Antarctica/Troll

    Troll

  • Antarctica/Vostok

    Vostok

  • Arctic/Longyearbyen

  • Asia/Aden

  • Asia/Almaty

    Kazakhstan (most areas)

  • Asia/Amman

  • Asia/Anadyr

    MSK+09 - Bering Sea

  • Asia/Aqtau

    Mangghystau/Mankistau

  • Asia/Aqtobe

    Aqtobe/Aktobe

  • Asia/Ashgabat

  • Asia/Atyrau

    Atyrau/Atirau/Gur'yev

  • Asia/Baghdad

  • Asia/Bahrain

  • Asia/Baku

  • Asia/Bangkok

  • Asia/Barnaul

    MSK+04 - Altai

  • Asia/Beirut

  • Asia/Bishkek

  • Asia/Brunei

  • Asia/Chita

    MSK+06 - Zabaykalsky

  • Asia/Choibalsan

    Dornod, Sukhbaatar

  • Asia/Colombo

  • Asia/Damascus

  • Asia/Dhaka

  • Asia/Dili

  • Asia/Dubai

  • Asia/Dushanbe

  • Asia/Famagusta

    Northern Cyprus

  • Asia/Gaza

    Gaza Strip

  • Asia/Hebron

    West Bank

  • Asia/Ho_Chi_Minh

  • Asia/Hong_Kong

  • Asia/Hovd

    Bayan-Olgiy, Govi-Altai, Hovd, Uvs, Zavkhan

  • Asia/Irkutsk

    MSK+05 - Irkutsk, Buryatia

  • Asia/Jakarta

    Java, Sumatra

  • Asia/Jayapura

    New Guinea (West Papua / Irian Jaya); Malukus/Moluccas

  • Asia/Jerusalem

  • Asia/Kabul

  • Asia/Kamchatka

    MSK+09 - Kamchatka

  • Asia/Karachi

  • Asia/Kathmandu

  • Asia/Khandyga

    MSK+06 - Tomponsky, Ust-Maysky

  • Asia/Kolkata

  • Asia/Krasnoyarsk

    MSK+04 - Krasnoyarsk area

  • Asia/Kuala_Lumpur

    Malaysia (peninsula)

  • Asia/Kuching

    Sabah, Sarawak

  • Asia/Kuwait

  • Asia/Macau

  • Asia/Magadan

    MSK+08 - Magadan

  • Asia/Makassar

    Borneo (east, south); Sulawesi/Celebes, Bali, Nusa Tengarra; Timor (west)

  • Asia/Manila

  • Asia/Muscat

  • Asia/Nicosia

    Cyprus (most areas)

  • Asia/Novokuznetsk

    MSK+04 - Kemerovo

  • Asia/Novosibirsk

    MSK+04 - Novosibirsk

  • Asia/Omsk

    MSK+03 - Omsk

  • Asia/Oral

    West Kazakhstan

  • Asia/Phnom_Penh

  • Asia/Pontianak

    Borneo (west, central)

  • Asia/Pyongyang

  • Asia/Qatar

  • Asia/Qostanay

    Qostanay/Kostanay/Kustanay

  • Asia/Qyzylorda

    Qyzylorda/Kyzylorda/Kzyl-Orda

  • Asia/Riyadh

  • Asia/Sakhalin

    MSK+08 - Sakhalin Island

  • Asia/Samarkand

    Uzbekistan (west)

  • Asia/Seoul

  • Asia/Shanghai

    Beijing Time

  • Asia/Singapore

  • Asia/Srednekolymsk

    MSK+08 - Sakha (E); North Kuril Is

  • Asia/Taipei

  • Asia/Tashkent

    Uzbekistan (east)

  • Asia/Tbilisi

  • Asia/Tehran

  • Asia/Thimphu

  • Asia/Tokyo

  • Asia/Tomsk

    MSK+04 - Tomsk

  • Asia/Ulaanbaatar

    Mongolia (most areas)

  • Asia/Urumqi

    Xinjiang Time

  • Asia/Ust-Nera

    MSK+07 - Oymyakonsky

  • Asia/Vientiane

  • Asia/Vladivostok

    MSK+07 - Amur River

  • Asia/Yakutsk

    MSK+06 - Lena River

  • Asia/Yangon

  • Asia/Yekaterinburg

    MSK+02 - Urals

  • Asia/Yerevan

  • Atlantic/Azores

    Azores

  • Atlantic/Bermuda

  • Atlantic/Canary

    Canary Islands

  • Atlantic/Cape_Verde

  • Atlantic/Faroe

  • Atlantic/Madeira

    Madeira Islands

  • Atlantic/Reykjavik

  • Atlantic/South_Georgia

  • Atlantic/St_Helena

  • Atlantic/Stanley

  • Australia/Adelaide

    South Australia

  • Australia/Brisbane

    Queensland (most areas)

  • Australia/Broken_Hill

    New South Wales (Yancowinna)

  • Australia/Currie

    Tasmania (King Island)

  • Australia/Darwin

    Northern Territory

  • Australia/Eucla

    Western Australia (Eucla)

  • Australia/Hobart

    Tasmania (most areas)

  • Australia/Lindeman

    Queensland (Whitsunday Islands)

  • Australia/Lord_Howe

    Lord Howe Island

  • Australia/Melbourne

    Victoria

  • Australia/Perth

    Western Australia (most areas)

  • Australia/Sydney

    New South Wales (most areas)

  • Europe/Amsterdam

  • Europe/Andorra

  • Europe/Astrakhan

    MSK+01 - Astrakhan

  • Europe/Athens

  • Europe/Belgrade

  • Europe/Berlin

    Germany (most areas)

  • Europe/Bratislava

  • Europe/Brussels

  • Europe/Bucharest

  • Europe/Budapest

  • Europe/Busingen

    Busingen

  • Europe/Chisinau

  • Europe/Copenhagen

  • Europe/Dublin

  • Europe/Gibraltar

  • Europe/Guernsey

  • Europe/Helsinki

  • Europe/Isle_of_Man

  • Europe/Istanbul

  • Europe/Jersey

  • Europe/Kaliningrad

    MSK-01 - Kaliningrad

  • Europe/Kiev

    Ukraine (most areas)

  • Europe/Kirov

    MSK+00 - Kirov

  • Europe/Lisbon

    Portugal (mainland)

  • Europe/Ljubljana

  • Europe/London

  • Europe/Luxembourg

  • Europe/Madrid

    Spain (mainland)

  • Europe/Malta

  • Europe/Mariehamn

  • Europe/Minsk

  • Europe/Monaco

  • Europe/Moscow

    MSK+00 - Moscow area

  • Europe/Oslo

  • Europe/Paris

  • Europe/Podgorica

  • Europe/Prague

  • Europe/Riga

  • Europe/Rome

  • Europe/Samara

    MSK+01 - Samara, Udmurtia

  • Europe/San_Marino

  • Europe/Sarajevo

  • Europe/Saratov

    MSK+01 - Saratov

  • Europe/Simferopol

    MSK+00 - Crimea

  • Europe/Skopje

  • Europe/Sofia

  • Europe/Stockholm

  • Europe/Tallinn

  • Europe/Tirane

  • Europe/Ulyanovsk

    MSK+01 - Ulyanovsk

  • Europe/Uzhgorod

    Ruthenia

  • Europe/Vaduz

  • Europe/Vatican

  • Europe/Vienna

  • Europe/Vilnius

  • Europe/Volgograd

    MSK+01 - Volgograd

  • Europe/Warsaw

  • Europe/Zagreb

  • Europe/Zaporozhye

    Zaporozh'ye/Zaporizhia; Lugansk/Luhansk (east)

  • Europe/Zurich

  • Indian/Antananarivo

  • Indian/Chagos

  • Indian/Christmas

  • Indian/Cocos

  • Indian/Comoro

  • Indian/Kerguelen

  • Indian/Mahe

  • Indian/Maldives

  • Indian/Mauritius

  • Indian/Mayotte

  • Indian/Reunion

  • Pacific/Apia

  • Pacific/Auckland

    New Zealand (most areas)

  • Pacific/Bougainville

    Bougainville

  • Pacific/Chatham

    Chatham Islands

  • Pacific/Chuuk

    Chuuk/Truk, Yap

  • Pacific/Easter

    Easter Island

  • Pacific/Efate

  • Pacific/Enderbury

    Phoenix Islands

  • Pacific/Fakaofo

  • Pacific/Fiji

  • Pacific/Funafuti

  • Pacific/Galapagos

    Galapagos Islands

  • Pacific/Gambier

    Gambier Islands

  • Pacific/Guadalcanal

  • Pacific/Guam

  • Pacific/Honolulu

    Hawaii

  • Pacific/Kiritimati

    Line Islands

  • Pacific/Kosrae

    Kosrae

  • Pacific/Kwajalein

    Kwajalein

  • Pacific/Majuro

    Marshall Islands (most areas)

  • Pacific/Marquesas

    Marquesas Islands

  • Pacific/Midway

    Midway Islands

  • Pacific/Nauru

  • Pacific/Niue

  • Pacific/Norfolk

  • Pacific/Noumea

  • Pacific/Pago_Pago

  • Pacific/Palau

  • Pacific/Pitcairn

  • Pacific/Pohnpei

    Pohnpei/Ponape

  • Pacific/Port_Moresby

    Papua New Guinea (most areas)

  • Pacific/Rarotonga

  • Pacific/Saipan

  • Pacific/Tahiti

    Society Islands

  • Pacific/Tarawa

    Gilbert Islands

  • Pacific/Tongatapu

  • Pacific/Wake

    Wake Island

  • Pacific/Wallis

  • UTC

ConfigurableTrue

configuration

Description Top-level container for configuration and state data related to the system configuration
Contextsystem configuration
Treeconfiguration
ConfigurableTrue

ended string

Description

End date and time of the commit

This field is not populated if the commit is in progress

Contextsystem configuration commit id number ended string
Treeended
String Length20 to 32
ConfigurableFalse

name string

Description Name of the configuration candidate the commit was triggered from
Contextsystem configuration commit id number name string
Treename
String Length1 to 255
ConfigurableFalse

status keyword

Description Current status of the commit
Context system configuration commit id number status keyword
Treestatus
Options
  • validating

  • publishing

  • unconfirmed

  • checkpoint

  • save

  • complete

  • reverting

  • failed

Configurable False

type keyword

Description Type of configuration candidate the commit was triggered from
Contextsystem configuration commit id number type keyword
Treetype
Options
  • shared

  • private

Configurable False

idle-timeout number

Description

The idle timeout of configuration candidates

After this period of no activity, the candidate is emptied and removed from the system.

Contextsystem configuration idle-timeout number
Treeidle-timeout
Default10080
Unitsminutes
ConfigurableTrue

last-change string

Description

Date and time of the last successful commit

Set to the time the configuration was loaded by management server, so is refreshed at boot time.

Contextsystem configuration last-change string
Treelast-change
String Length20 to 32
ConfigurableFalse

path-reference string

Description

Reference to a valid YANG path, in CLI notation

This path may include keys, wildcards, ranges, and other management server supported constructs. Ranges will be expanded. The root path can be specified with '/'.

E.g. / "/interface" "/acl ipv4-filter foo* description"

Contextsystem configuration role name reference rule path-reference string
ConfigurableTrue

action keyword

Description Action to allow for this path
Context system configuration role name reference rule path-reference string action keyword
Treeaction
Options
  • read

    This path may be read by the role

  • write

    This path may be written and read by the role

  • deny

    This path may not be read or written to by the role

ConfigurableTrue

name string

Description

Name of the candidate the session is active on

Set to 'default' if a non-named candidate is active

Contextsystem configuration session id number name string
Treename
String Length1 to 255
ConfigurableFalse

dhcp-server

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionConfigures the dhcp server
Contextsystem dhcp-server
Treedhcp-server
ConfigurableTrue

admin-state keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionGlobally enable or disable the dhcp server Disabling this will disable all dhcp servers.
Contextsystem dhcp-server admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

network-instance name reference

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionList of network instances to run a dhcp server in
Contextsystem dhcp-server network-instance name reference
Treenetwork-instance
ConfigurableTrue

dhcpv4

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the dhcpv4 context
Contextsystem dhcp-server network-instance name reference dhcpv4
Treedhcpv4
ConfigurableTrue

admin-state keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionAdministratively enable or disable the dhcp server
Contextsystem dhcp-server network-instance name reference dhcpv4 admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

oper-state keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionDetails if the dhcp server is operationally available
Contextsystem dhcp-server network-instance name reference dhcpv4 oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

options

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the options context
Contextsystem dhcp-server network-instance name reference dhcpv4 options
Treeoptions
ConfigurableTrue

bootfile-name string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionThe URL to the provisioning script the client will use during booting
Contextsystem dhcp-server network-instance name reference dhcpv4 options bootfile-name string
Treebootfile-name
String Length1 to 128
ConfigurableTrue

dns-server string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionAn Ordered List of DNS servers to return to the dhcp client
Contextsystem dhcp-server network-instance name reference dhcpv4 options dns-server string
Treedns-server
ConfigurableTrue
Max. Elements4

domain-name string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionThe domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System
Contextsystem dhcp-server network-instance name reference dhcpv4 options domain-name string
Treedomain-name
String Length1 to 253
ConfigurableTrue

hostname string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionHost Name option of the dhcp client
Contextsystem dhcp-server network-instance name reference dhcpv4 options hostname string
Treehostname
String Length1 to 63
ConfigurableTrue

ntp-server string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionList of NTP Servers to return to the dhcp client
Contextsystem dhcp-server network-instance name reference dhcpv4 options ntp-server string
Treentp-server
ConfigurableTrue
Max. Elements4

router string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionIPv4 address of the gateway for the dhcp client
Contextsystem dhcp-server network-instance name reference dhcpv4 options router string
Treerouter
ConfigurableTrue

server-id string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionIP address the dhcp server must match any address within the network_instance e.g. sub-interface primary address, loopback address, anycast gateway address in case of multihoming
Contextsystem dhcp-server network-instance name reference dhcpv4 options server-id string
Treeserver-id
ConfigurableTrue

domain-name string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionThe domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System
Contextsystem dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options domain-name string
Treedomain-name
String Length1 to 253
ConfigurableTrue

server-id string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionIP address the dhcp server must match any address within the network_instance e.g. sub-interface primary address, loopback address, anycast gateway address in case of multihoming
Contextsystem dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options server-id string
Treeserver-id
ConfigurableTrue

statistics

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the statistics context
Contextsystem dhcp-server network-instance name reference dhcpv4 statistics
Treestatistics
ConfigurableFalse

trace-options

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionContainer for tracing DHCP server operations instance
Contextsystem dhcp-server network-instance name reference dhcpv4 trace-options
Treetrace-options
ConfigurableTrue

trace keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionList of events to trace
Contextsystem dhcp-server network-instance name reference dhcpv4 trace-options trace keyword
Treetrace
Options
  • messages

    Capture all DHCP server messages sent and received

ConfigurableTrue

dhcpv6

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the dhcpv6 context
Contextsystem dhcp-server network-instance name reference dhcpv6
Treedhcpv6
ConfigurableTrue

admin-state keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionAdministratively enable or disable the dhcp server
Contextsystem dhcp-server network-instance name reference dhcpv6 admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

oper-state keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionDetails if the dhcp server is operationally available
Contextsystem dhcp-server network-instance name reference dhcpv6 oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

options

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the options context
Contextsystem dhcp-server network-instance name reference dhcpv6 options
Treeoptions
ConfigurableTrue

dns-server string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionAn Ordered List of DNS servers to return to the dhcp client
Contextsystem dhcp-server network-instance name reference dhcpv6 options dns-server string
Treedns-server
ConfigurableTrue
Max. Elements4

statistics

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the statistics context
Contextsystem dhcp-server network-instance name reference dhcpv6 statistics
Treestatistics
ConfigurableFalse

trace-options

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionContainer for tracing DHCP server operations instance
Contextsystem dhcp-server network-instance name reference dhcpv6 trace-options
Treetrace-options
ConfigurableTrue

trace keyword

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionList of events to trace
Contextsystem dhcp-server network-instance name reference dhcpv6 trace-options trace keyword
Treetrace
Options
  • messages

    Capture all DHCP server messages sent and received

ConfigurableTrue

dns

Description Top-level container for DNS configuration and state
Contextsystem dns
Treedns
ConfigurableTrue

name string

Description Name of host entry
Context system dns host-entry name string
String Length1 to 253
ConfigurableTrue

oper-state keyword

Description Details the operational state of the DNS client
Contextsystem dns oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

search-list string

Description An ordered list of domains to search when resolving a host name
Contextsystem dns search-list string
Treesearch-list
String Length1 to 253
ConfigurableTrue

server-list (ipv4-address | ipv6-address)

Description List of the DNS servers that the resolver should query
Contextsystem dns server-list (ipv4-address | ipv6-address)
Treeserver-list
ConfigurableTrue
Max. Elements3

features string

Description Features enabled on this platform
Context system features string
Treefeatures
String Length1 to 255
ConfigurableFalse

ftp-server

Description Top-level container for FTP server configuration and state
Contextsystem ftp-server
Treeftp-server
ConfigurableTrue

oper-state keyword

Description Details the operational state of the FTP server
Contextsystem ftp-server network-instance name reference oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

source-address (ipv4-address | ipv6-address)

Description

IPv4 or IPv6 address for the FTP server to listen on within the network-instance

Default behavior is to listen on '::', which will listen on all addresses for both IPv4 and IPv6. In order to listen on IPv4 only, this field should be set to '0.0.0.0'.

Contextsystem ftp-server network-instance name reference source-address (ipv4-address | ipv6-address)
Treesource-address
Default::
ConfigurableTrue

admin-state keyword

Description Globally enable or disable the gNMI server Disabling this will disable all gNMI servers.
Contextsystem gnmi-server admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

commit-save boolean

Description Specifies whether to save startup configuration after every successful commit
Contextsystem gnmi-server commit-save boolean
Treecommit-save
Defaultfalse
ConfigurableTrue

oper-state keyword

Description Details if the gNMI server is operationally available
Contextsystem gnmi-server network-instance name reference oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

rate-limit number

Description Set a limit on the number of connection attempts per minute
Contextsystem gnmi-server rate-limit number
Treerate-limit
Range0 to 65535
Default60
ConfigurableTrue

mode keyword

Description Subscription mode (ON_CHANGE, SAMPLE, TARGET_DEFINED, POLL, ONCE)
Contextsystem gnmi-server subscription id number mode keyword
Treemode
Options
  • ON_CHANGE

  • SAMPLE

  • TARGET_DEFINED

  • POLL

  • ONCE

Configurable False

timeout number

Description Set the idle timeout in seconds on gNMI connections
Contextsystem gnmi-server timeout number
Treetimeout
Range0 to 65535
Default7200
Unitsseconds
ConfigurableTrue

oper-state keyword

Description Details if the gNMI server is operationally available
Contextsystem gnmi-server unix-socket oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

information

Description Top-level container for system information configuration and state
Contextsystem information
Treeinformation
ConfigurableTrue

contact string

Description

The system contact

This field represents contact information for the person or group that maintains the system. This field is exposed via SNMP at the sysContact OID.

Contextsystem information contact string
Treecontact
ConfigurableTrue

description string

Description

The system description

This field is system generated, and is a combination of the system host name, software version, kernel version, and build date. The template for this field is: SRLinux-<version> <hostname> <kernel> <build date>. This field is exposed via SNMP at the sysDescr OID.

Contextsystem information description string
Treedescription
ConfigurableFalse

location string

Description

The system location

This field represents the location of the system, and is commonly used by inventory management systems to group elements together. This field is exposed via SNMP at the sysLocation OID.

Contextsystem information location string
Treelocation
ConfigurableTrue

version string

Description

The system version

This field represents the version of the management server

Contextsystem information version string
Treeversion
ConfigurableFalse

admin-state keyword

Description Globally enable or disable the JSON RPC server Disabling this will disable all JSON RPC servers.
Contextsystem json-rpc-server admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

oper-state keyword

Description Details if the JSON RPC server is operationally available
Contextsystem json-rpc-server network-instance name reference http oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

oper-state keyword

Description Details if the JSON RPC server is operationally available
Contextsystem json-rpc-server network-instance name reference https oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

admin-state keyword

Description Administratively enable or disable the JSON RPC server via unix socket This requires the JSON RPC server to be globally enabled
Contextsystem json-rpc-server unix-socket admin-state keyword
Treeadmin-state
Defaultdisable
Options
  • enable

  • disable

Configurable True

oper-state keyword

Description Details if the JSON RPC server is operationally available
Contextsystem json-rpc-server unix-socket oper-state keyword
Treeoper-state
Options
  • up

    Component or process is operational

  • down

    Component or process is not operational

  • empty

    Component slot is empty

  • downloading

    Component is downloading image into memory

  • booting

    Component is booting downloaded image

  • starting

    Component image operational, application processes starting

  • failed

    Component or process has failed

  • synchronizing

    Component is currently being synchronized

  • upgrading

    Component is currently being upgraded

  • low-power

    Component is offline due to insufficient system power

  • degraded

    Component or process is in a degraded state

  • warm-reboot

    Component or process is currently warm rebooting

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

ConfigurableFalse

lacp

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionEnter the lacp context
Contextsystem lacp
Treelacp
ConfigurableTrue

system-id string

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionThe MAC address portion of the node's System ID. This is combined with the system priority to construct the 8-octet system-id
Contextsystem lacp system-id string
Treesystem-id
ConfigurableTrue

system-priority number

Note:

This command is available for the following platforms:

  • 7220 IXR-D2

  • 7250 IXR-10

  • 7220 IXR-D3L

  • 7220 IXR-D2L

  • 7220 IXR-H3

  • 7220 IXR-H2

  • 7220 IXR-D3

  • 7250 IXR-6

  • 7220 IXR-D1

DescriptionSystem priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system.
Contextsystem lacp system-priority number
Treesystem-priority
ConfigurableTrue

lldp

Description Top-level container for LLDP configuration and state data
Contextsystem lldp
Treelldp
ConfigurableTrue

admin-state keyword

Description Enable or disable LLDP at the system level
Contextsystem lldp admin-state keyword
Treeadmin-state
Defaultenable
Options
  • enable

  • disable

Configurable True

chassis-id string

Description The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent
Contextsystem lldp chassis-id string
Treechassis-id
ConfigurableFalse

chassis-id-type keyword

Description

The source for the chassis identifier string

It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

Contextsystem lldp chassis-id-type keyword
Treechassis-id-type
DefaultMAC_ADDRESS
Options
  • CHASSIS_COMPONENT

    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737

  • INTERFACE_ALIAS

    Chassis identifier based on the value of ifAlias object defined in IETF RFC 2863

  • PORT_COMPONENT

    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port or backplane component

  • MAC_ADDRESS

    Chassis identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order), of a port on the containing chassis as defined in IEEE Std 802-2001

  • NETWORK_ADDRESS

    Chassis identifier based on a network address, associated with a particular chassis. The encoded address is composed of two fields. The first field is a single octet, representing the IANA AddressFamilyNumbers value for the specific address type, and the second field is the network address value

  • INTERFACE_NAME

    Chassis identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863

  • LOCAL

    Chassis identifier based on a locally defined value

ConfigurableFalse

hello-timer number

Description System level hello timer for the LLDP protocol
Contextsystem lldp hello-timer number
Treehello-timer
Default30
Unitsseconds
Configurable True

hold-multiplier number

Description

System level hold multiplier, used to define neighbor aging

This field defines how many hellos need to be missed before a neighbor is aged out.

This field also is used along with the 'hello-timer' field to define the TTL TLV in outgoing LLDPDUs.

Contextsystem lldp hold-multiplier number
Treehold-multiplier
Default4
ConfigurableTrue

name string

Description

Name of the system capability advertised by the neighbor

Capabilities are represented in a bitmap that defines the primary functions of the system. The capabilities are defined in IEEE 802.1AB.

Contextsystem lldp interface name reference neighbor id string capability name string
ConfigurableFalse

chassis-id string

Description

The chassis ID of the remote neighbor

The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent

Contextsystem lldp interface name reference neighbor id string chassis-id string
Treechassis-id
ConfigurableFalse

chassis-id-type keyword

Description

The type of identifier used in the chassis-id field

This field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

Contextsystem lldp interface name reference neighbor id string chassis-id-type keyword
Treechassis-id-type
DefaultMAC_ADDRESS
Options
  • CHASSIS_COMPONENT

    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737

  • INTERFACE_ALIAS

    Chassis identifier based on the value of ifAlias object defined in IETF RFC 2863

  • PORT_COMPONENT

    Chassis identifier based on the value of entPhysicalAlias object defined in IETF RFC 2737 for a port or backplane component

  • MAC_ADDRESS

    Chassis identifier based on the value of a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order), of a port on the containing chassis as defined in IEEE Std 802-2001

  • NETWORK_ADDRESS

    Chassis identifier based on a network address, associated with a particular chassis. The encoded address is composed of two fields. The first field is a single octet, representing the IANA AddressFamilyNumbers value for the specific address type, and the second field is the network address value

  • INTERFACE_NAME

    Chassis identifier based on the name of the interface, e.g., the value of ifName object defined in IETF RFC 2863

  • LOCAL

    Chassis identifier based on a locally defined value

ConfigurableFalse

oui string

Description

The organizationally unique identifier field from the custom TLV

This field shall contain the organization's OUI as defined in Clause 9 of IEEE Std 802. The high-order octet is 0 and the low-order 3 octets are the SMI Network Management Private Enterprise Code of the Vendor in network byte order, as defined in the 'Assigned Numbers' RFC [RFC3232].

Contextsystem lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string
ConfigurableFalse

oui-subtype string

Description

The subtype value defined by the OUI for this custom TLV

The organizationally defined subtype field shall contain a unique subtype value assigned by the defining organization.

Contextsystem lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string
ConfigurableFalse

address string

Description

The management address received from the remote LLDP neighbor

The Management Address is a mandatory TLV which identifies a network address associated with the LLDP agent, which can be used to reach the agent on the port identified in the Port ID TLV.

Contextsystem lldp interface name reference neighbor id string management-address address string
ConfigurableFalse

type keyword

Description

The type of management address referenced in the address field

The enumerated value for the network address type identified in this TLV. This enumeration is defined in the 'Assigned Numbers' RFC [RFC3232] and the ianaAddressFamilyNumbers object.

Contextsystem lldp interface name reference neighbor id string management-address address string type keyword
Treetype
Options
  • IPv4

    Use IPv4 address for management address type

  • IPv6

    Use IPv6 address for management address type

ConfigurableFalse

port-description string

Description

The description of the port referenced in the port-id field

The binary string containing the actual port identifier for the port which this LLDP PDU was transmitted. The source and format of this field is defined by PtopoPortId from RFC2922.

Contextsystem lldp interface name reference neighbor id string port-description string
Treeport-description
ConfigurableFalse

port-id (string | binary)

Description

The Port ID of the remote neighbor

The Port ID is a mandatory TLV which identifies the port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional.

Context