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
      +  linuxadmin-user
         +  password string
         -  username string
      +  password
         +  aging number
         +  change-on-first-login boolean
         +  complexity-rules
            +  allow-username boolean
            +  maximum-length number
            +  minimum-length number
            +  minimum-lowercase number
            +  minimum-numeric number
            +  minimum-special-character number
            +  minimum-uppercase number
         +  history number
         +  lockout-policy
            +  attempts number
            +  lockout number
            +  time 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 
         +  services keyword
         +  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
      -  last-start-type keyword
      -  launch-command string
      -  oom-score-adj number
      -  path string
      -  pid number
      -  restricted-operations keyword
      -  search-command string
      -  state keyword
      -  statistics
         -  restart-count number
      -  supported-restart-types keyword
      -  version string
      -  yang
         -  modules string
         -  source-directories string
+  authentication
   +  keychain name string 
      +  admin-state keyword
      +  description string
      -  expired boolean
      +  key index number 
         +  algorithm keyword
         +  authentication-key string
         +  receive-lifetime
            +  end-time (keyword | date-and-time)
            +  start-time string
         +  send-lifetime
            +  send-and-receive boolean
            +  start-time string
      +  tolerance number
      +  type keyword
      -  usable boolean
+  banner
   +  login-banner string
   +  motd-banner string
+  boot
   +  autoboot
      +  admin-state keyword
      +  attempts number
      +  client-id keyword
      +  interface reference
      +  mode string
      -  oper-state string
      +  timeout number
   -  image string
+  bridge-table
   +  mac-learning
      -  mac-relearn-only boolean
   +  mac-limit
      -  maximum-entries number
      -  warning-threshold-pct number
   -  proxy-arp
      -  statistics
         -  active-entries number
         -  in-active-entries number
         -  neighbor-origin origin keyword 
            -  active-entries number
            -  in-active-entries number
            -  pending-entries number
            -  total-entries number
         -  pending-entries number
         -  total-entries number
   -  proxy-nd
      -  statistics
         -  active-entries number
         -  in-active-entries number
         -  neighbor-origin origin keyword 
            -  active-entries number
            -  in-active-entries number
            -  pending-entries number
            -  total-entries number
         -  pending-entries number
         -  total-entries 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
            +  tftp-server-address string
            +  tftp-server-name 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
                  +  tftp-server-address string
                  +  tftp-server-name 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)
+  event-handler
   +  instance name string 
      +  admin-state keyword
      -  last-errored-execution
         -  end-time string
         -  input string
         -  oper-down-reason keyword
         -  oper-down-reason-detail string
         -  output string
         -  start-time string
         -  stdout-stderr string
         -  upython-duration number
      -  last-execution
         -  end-time string
         -  input string
         -  oper-down-reason keyword
         -  oper-down-reason-detail string
         -  output string
         -  start-time string
         -  stdout-stderr string
         -  upython-duration number
      -  oper-state keyword
      +  options
         +  object name string 
            +  value string
            +  values string
      +  paths string
      -  statistics
         -  execution-count number
         -  execution-errors number
         -  execution-successes number
         -  execution-timeouts number
         -  upython-duration number
      +  upython-script string
   +  run-as-user reference
-  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
      +  yang-models keyword
   +  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
      +  yang-models keyword
+  gribi-server
   +  admin-state keyword
   -  client id number 
      -  election-id string
      -  persistence-mode keyword
      -  remote-host (ipv4-address | ipv6-address)
      -  remote-port number
      -  start-time string
      -  user string
      -  user-agent string
   +  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
   +  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
-  l2cp-transparency
   -  l2cp-statistics
      -  dot1x
         -  in-trap-to-cpu-packets number
         -  in-tunneled-packets number
         -  last-clear string
      -  lacp
         -  in-trap-to-cpu-packets number
         -  in-tunneled-packets number
         -  last-clear string
      -  last-clear string
      -  lldp
         -  in-trap-to-cpu-packets number
         -  in-tunneled-packets number
         -  last-clear string
      -  ptp
         -  in-trap-to-cpu-packets number
         -  in-tunneled-packets number
         -  last-clear string
      -  total-in-discarded-packets number
      -  total-in-packets number
      -  total-in-trap-to-cpu-packets number
      -  total-in-tunneled-packets number
      -  xstp
         -  in-trap-to-cpu-packets number
         -  in-tunneled-packets number
         -  last-clear string
+  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 identityref 
            -  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
+  management
   +  openconfig
      +  admin-state keyword
      -  oper-state keyword
+  mirroring
   +  mirroring-instance name string 
      +  admin-state keyword
      +  description string
      +  mirror-destination
         +  local string
         +  remote
            +  encap keyword
            +  network-instance reference
            +  tunnel-end-points
               +  admin-state keyword
               +  dst-ipv4 string
               +  dst-ipv6 string
               -  oper-state keyword
               +  src-ipv4 string
               +  src-ipv6 string
      +  mirror-source
         +  acl
            +  ipv4-filter name reference 
               +  entry sequence-id reference 
            +  ipv6-filter name reference 
               +  entry sequence-id reference 
         +  interface name string 
            +  direction keyword
         +  subinterface name string 
            +  direction keyword
      -  oper-down-reason keyword
      -  oper-state keyword
+  mpls
   +  label-ranges
      +  dynamic name string 
         -  allocated-labels number
         +  end-label number
         -  free-labels number
         +  start-label number
         -  status keyword
         -  user index number 
            -  protocol identityref
      +  static name string 
         -  allocated-labels number
         +  end-label number
         -  free-labels number
         +  shared boolean
         +  start-label number
         -  status keyword
         -  user index number 
            -  protocol identityref
   +  services
+  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
                        +  manual-alg
                           +  primary-evi-range start-evi number 
                              +  end-evi number
                        -  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 ethernet-interface reference 
                  +  multi-homing-mode keyword
                  +  next-hop l3-next-hop (ipv4-address | ipv6-address) 
                     +  evi start number 
                  -  oper-down-reason keyword
                  -  oper-esi string
                  -  oper-multi-homing-mode keyword
                  -  oper-state keyword
                  +  routes
                     +  ethernet-segment
                        +  originating-ip keyword
                     +  next-hop keyword
                  +  type 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 number
      -  offset number
      -  poll-interval number
      +  prefer boolean
      -  stratum number
   -  synchronized (ipv4-address | ipv6-address | string)
+  p4rt-server
   +  admin-state keyword
   -  client id number 
      -  election-id string
      -  forwarding-complex
         -  id number
         -  location string
      -  primary boolean
      -  remote-host (ipv4-address | ipv6-address)
      -  remote-port number
      -  start-time string
      -  user string
      -  user-agent string
   +  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
   +  timeout number
   +  trace-options keyword
   +  unix-socket
      +  admin-state keyword
      -  oper-state keyword
      -  socket-path string
      +  tls-profile reference
      +  use-authentication boolean
+  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
+  sync
   +  freq-clock
      -  active-ref keyword
      -  freq-clock-state keyword
      -  freq-offset decimal-number
      +  ql-input-threshold keyword
      -  ref-switch-state keyword
      +  synce-mode keyword
      +  system-ql-enable boolean
      -  system-ql-value keyword
      +  wait-to-restore number
   +  freq-references
      +  instance instance-number number 
         +  admin-state keyword
         -  frequency-offset decimal-number
         +  lockout-ref boolean
         -  oper-state keyword
         +  priority number
         +  ql-override keyword
         +  ql-processing boolean
         -  ql-status keyword
         -  ql-value keyword
         -  ref-status keyword
         +  switch-ref-request keyword
         +  underlying-interface string
   +  ppstest
      +  admin-state keyword
   +  ptp
      +  frequency-ref string
      +  instance instance-number number 
         -  current-ds
            -  mean-delay number
            -  offset-from-master number
            -  steps-removed number
            -  synchronization-uncertain boolean
         +  default-ds
            -  clock-identity binary
            -  clock-quality
               -  clock-accuracy number
               -  clock-class number
               -  offset-scaled-log-variance number
            -  clock-state keyword
            +  clockclass-input-threshold number
            -  current-time
               -  time-nano-seconds number
               -  time-seconds number
            +  domain-number number
            +  instance-enable boolean
            +  instance-type keyword
            +  local-priority number
            +  max-steps-removed number
            -  number-ports number
            +  priority1 number
            +  priority2 number
            -  slave-only boolean
            +  sync-uncertain-enable boolean
            -  two-step-flag boolean
         -  parent-ds
            -  grandmaster-clock-quality
               -  clock-accuracy number
               -  clock-class number
               -  offset-scaled-log-variance number
            -  grandmaster-identity binary
            -  grandmaster-priority1 number
            -  grandmaster-priority2 number
            -  observed-parent-clock-phase-change-rate number
            -  observed-parent-offset-scaled-log-variance number
            -  parent-port-identity
               -  clock-identity binary
               -  port-number number
            -  parent-stats boolean
            -  protocol-address
               -  address-field string
               -  address-length number
               -  network-protocol keyword
            -  synchronization-uncertain boolean
         +  path-trace-ds
            +  enable boolean
            -  list binary
         +  port-ds-list port-number number 
            +  addressing-mode keyword
            +  admin-state keyword
            +  announce-receipt-timeout number
            +  asym-correction number
            -  delay-mechanism keyword
            +  delay-resp-receipt-timeout number
            +  dest-mac keyword
            +  encap-type keyword
            +  local-priority number
            +  log-announce-interval number
            +  log-min-delay-req-interval number
            +  log-sync-interval number
            -  major-version-number number
            +  master-only boolean
            -  minor-version-number number
            -  peer-mean-path-delay number
            +  port-role keyword
            -  port-state keyword
            +  ptp-entity-type keyword
            -  ptp-port-mac-address string
            -  statistics
               -  anno-msg-rx number
               -  anno-msg-tx number
               -  del-req-msg-rx number
               -  del-req-msg-tx number
               -  del-resp-msg-rx number
               -  del-resp-msg-tx number
               -  follow-up-msg-rx number
               -  follow-up-msg-tx number
               -  sync-msg-rx number
               -  sync-msg-tx number
            +  sync-receipt-timeout number
            +  underlying-interface string
            -  vlan-id number
         +  time-err-mon
            -  list number
            +  time-error-mon-duration number
            +  time-error-mon-execute 
            +  time-error-mon-interval number
            +  time-error-mon-ref keyword
         -  time-properties-ds
            -  current-utc-offset number
            -  current-utc-offset-valid boolean
            -  frequency-traceable boolean
            -  leap59 boolean
            -  leap61 boolean
            -  ptp-timescale boolean
            -  time-source keyword
            -  time-traceable boolean
      +  ptp-profile keyword
   +  time-clock
      +  time-ref keyword
+  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
PlatformsSupported on all platforms

aaa

Description Top-level container for AAA services
Context system aaa
Treeaaa
ConfigurableTrue
PlatformsSupported on all platforms

accounting

Description Top-level container for accounting
Context system aaa accounting
Treeaccounting
ConfigurableTrue
PlatformsSupported on all platforms
accounting-method reference
Description

Ordered list of server-groups to use for accounting in the system

If accounting fails with one method, the next defined method is tried -- failure of all methods results in the accounting request failing.

Contextsystem aaa accounting accounting-method reference
Treeaccounting-method
Referencesystem aaa server-group name string
ConfigurableTrue
PlatformsSupported on all platforms
event event-type identityref
Description List of events subject to accounting
Context system aaa accounting event event-type identityref
Treeevent
ConfigurableTrue
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms

authentication

Description Top-level container for global authentication data
Contextsystem aaa authentication
Treeauthentication
ConfigurableTrue
PlatformsSupported on all platforms
admin-user
Description Enclosing container for admin user
Context system aaa authentication admin-user
Treeadmin-user
ConfigurableTrue
PlatformsSupported on all platforms
password string
Description

The admin password, supplied as cleartext

The system will hash the value, storing only the hashed value

Contextsystem aaa authentication admin-user password string
Treepassword
ConfigurableTrue
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
linuxadmin-user
Description Enclosing container for linuxadmin user
Contextsystem aaa authentication linuxadmin-user
Treelinuxadmin-user
ConfigurableTrue
PlatformsSupported on all platforms
password
Description Top-level container for Password Complexity and local user lockout
Contextsystem aaa authentication password
Treepassword
ConfigurableTrue
PlatformsSupported on all platforms
aging number
Description The user password will expire after the aging time
Contextsystem aaa authentication password aging number
Treeaging
Range0 to 500
Default90
Unitsdays
Configurable True
PlatformsSupported on all platforms
complexity-rules
Description Top-level container for Password Complexity Rules
Contextsystem aaa authentication password complexity-rules
Treecomplexity-rules
ConfigurableTrue
PlatformsSupported on all platforms
history number
Description Defines how many previous passwords a new password is matched against, such that a new password can't be one of the previous n passwords
Contextsystem aaa authentication password history number
Treehistory
Range0 to 20
Default4
ConfigurableTrue
PlatformsSupported on all platforms
lockout-policy
Description Top-level container for Lockout Policy
Contextsystem aaa authentication password lockout-policy
Treelockout-policy
ConfigurableTrue
PlatformsSupported on all platforms
lockout number
Description The time duration in minutes the user account will be locked out. A value of 0 means that the use account will be locked out/disabled indefinitely
Contextsystem aaa authentication password lockout-policy lockout number
Treelockout
Range0 to 1440
Default15
Unitsminutes
Configurable True
PlatformsSupported on all platforms
session id number
Description List of active sessions in the system
Contextsystem aaa authentication session id number
Treesession
ConfigurableFalse
PlatformsSupported on all platforms
user username string
Description List of local users configured on the system
Contextsystem aaa authentication user username string
Treeuser
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements128
username string
Description Assigned username for this user
Context system aaa authentication user username string
String Length1 to 32
ConfigurableTrue
PlatformsSupported on all platforms
password string
Description

The user password, supplied as cleartext

The system will hash the value on input, storing only the hashed value

Contextsystem aaa authentication user username string password string
Treepassword
ConfigurableTrue
PlatformsSupported on all platforms
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
Referencesystem aaa authorization role rolename string
ConfigurableTrue
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
Max. Elements32

authorization

Description Top-level container for authorization configuration and operational state data
Contextsystem aaa authorization
Treeauthorization
ConfigurableTrue
PlatformsSupported on all platforms
role rolename string
Description List of local roles configured on the system
Contextsystem aaa authorization role rolename string
Treerole
ConfigurableTrue
PlatformsSupported on all platforms
rolename string
Description Assigned rolename for this role
Context system aaa authorization role rolename string
String Length1 to 32
ConfigurableTrue
PlatformsSupported on all platforms
services keyword
Description

Services that members of this role are authorized for

Services are additive, if a user is a member of multiple roles, the available services are merged.

Contextsystem aaa authorization role rolename string services keyword
Treeservices
Options
  • cli

  • gnmi

  • gribi

  • p4rt

  • json-rpc

  • ftp

Configurable True
PlatformsSupported on all platforms
tacacs
Description Top-level container for configuration relating to TACACS+ interworking with roles
Contextsystem aaa authorization role rolename string tacacs
Treetacacs
ConfigurableTrue
PlatformsSupported on all platforms
priv-lvl number
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
PlatformsSupported on all platforms

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
PlatformsSupported on all platforms
Max. Elements2
name string
Description User defined name for the server group
Contextsystem aaa server-group name string
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
priv-lvl-authorization boolean
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
Max. Elements5
address (ipv4-address | ipv6-address)
Description Address used to reach the server
Context system aaa server-group name string server address (ipv4-address | ipv6-address)
ConfigurableTrue
PlatformsSupported on all platforms
name string
Description User defined name assigned to the server
Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) name string
Treename
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
network-instance reference
Description

Reference to a configured network-instance used for reachability to the server

This network-instance must already exist in the system, and different servers within the same server-group may use difference network-instances for connectivity.

Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) network-instance reference
Treenetwork-instance
Referencenetwork-instance name string
ConfigurableTrue
PlatformsSupported on all platforms
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.

  • waiting

    Component or process is currently waiting

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

ConfigurableFalse
PlatformsSupported on all platforms
statistics
Description Enclosing container for server statistics
Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
tacacs
Description Top-level container for TACACS+ server data
Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) tacacs
Treetacacs
ConfigurableTrue
PlatformsSupported on all platforms
port number
Description The port number on which to contact the TACACS+ server
Contextsystem aaa server-group name string server address (ipv4-address | ipv6-address) tacacs port number
Treeport
Range0 to 65535
Default49
ConfigurableTrue
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms

app-management

Description Top-level container for application configuration and state
Contextsystem app-management
Treeapp-management
ConfigurableFalse
PlatformsSupported on all platforms

application name string

Description List of all applications managed by the application manager
Contextsystem app-management application name string
Treeapplication
ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
failure-threshold number
Description

How many restarts within 'failure-window' are required to trigger the failure action

Setting this value to 0 will result in no action taking place on application restarts

Contextsystem app-management application name string failure-threshold number
Treefailure-threshold
Range0 to 255
ConfigurableFalse
PlatformsSupported on all platforms
last-start-type keyword
Description Indicates the type of the most recent start or restart of this application instance
Contextsystem app-management application name string last-start-type keyword
Treelast-start-type
Options
  • warm

    A warm start indicates that the application will leave state in IDB during a restart, and recover it post restart

    A warm start indicates that the application will leave state in IDB during a restart, and recover it post restart This type results in less disruption to surrounding applications and functionality.

  • cold

    A cold start indicates that the application will not leave state in IDB during a restart

    A cold start indicates that the application will not leave state in IDB during a restart This type is equivalent to a normal application restart, i.e. one where the application's state is purged from the system during the restart, and recreated after.

ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
supported-restart-types keyword
Description Indicates the supported restart types for this application
Contextsystem app-management application name string supported-restart-types keyword
Treesupported-restart-types
Options
  • warm

    A warm start indicates that the application will leave state in IDB during a restart, and recover it post restart

    A warm start indicates that the application will leave state in IDB during a restart, and recover it post restart This type results in less disruption to surrounding applications and functionality.

  • cold

    A cold start indicates that the application will not leave state in IDB during a restart

    A cold start indicates that the application will not leave state in IDB during a restart This type is equivalent to a normal application restart, i.e. one where the application's state is purged from the system during the restart, and recreated after.

ConfigurableFalse
PlatformsSupported on all platforms
yang
Description Top-level container for application state related to YANG
Contextsystem app-management application name string yang
Treeyang
ConfigurableFalse
PlatformsSupported on all platforms

authentication

Description Container for protocol authentication options available system wide
Contextsystem authentication
Treeauthentication
ConfigurableTrue
PlatformsSupported on all platforms

keychain name string

Description List of system keychains
Context system authentication keychain name string
Treekeychain
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements1024
name string
Description The user configured name for the keychain
Contextsystem authentication keychain name string
String Length1 to 255
ConfigurableTrue
PlatformsSupported on all platforms
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/or all inbound messages with authentication data are dropped, depending on the context.

A keychain is operationally disabled in a particular direction (send/receive) if:

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

  • disable

Configurable True
PlatformsSupported on all platforms
expired boolean
Description

The value of this object indicates whether the keychain is expired

Expired can mean past end-time or prior to start-time.

Contextsystem authentication keychain name string expired boolean
Treeexpired
ConfigurableFalse
PlatformsSupported on all platforms
key index number
Description List of keys in the keychain
Context system authentication keychain name string key index number
Treekey
ConfigurableTrue
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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 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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
receive-lifetime
Description Enter the receive-lifetime context
Context system authentication keychain name string key index number receive-lifetime
Treereceive-lifetime
ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
end-time (keyword | date-and-time)
Description

The time at which the key becomes invalid for use in the receive direction

The default is forever.

Context system authentication keychain name string key index number receive-lifetime end-time (keyword | date-and-time)
Treeend-time
String Length20 to 32
Options
  • forever

    Receive key does not expire (equivalent to infinite tolerance)

ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
start-time string
Description

The time at which the key becomes valid for use in the receive direction

If send-and-receive is true, this value is ignored. If send-and-receive is false the default is the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

If there are multiple keys in the keychain the one used for checking received authentication information is the key with the most recent receive-lifetime start-time that is earlier than the current date and time and that has not exceeded its receive-lifetime end-time by more than 'tolerance' seconds

Contextsystem authentication keychain name string key index number receive-lifetime start-time string
Treestart-time
String Length20 to 32
ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
send-lifetime
Description Specifies the lifetime of the key for sending authentication information to the peer
Contextsystem authentication keychain name string key index number send-lifetime
Treesend-lifetime
ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
send-and-receive boolean
Description

When this is set to true (the default value), the specified start-time also applies to the receive direction

When set to false, router uses the specific start-time for the receive direction (asymmetric mode).

Contextsystem authentication keychain name string key index number send-lifetime send-and-receive boolean
Treesend-and-receive
ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
start-time string
Description

The time at which the key becomes valid for use in the send direction

The default is the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

If there are multiple keys in the keychain the one used for sending authentication information is the key with the most recent send-lifetime start-time that is earlier than the current date and time

Contextsystem authentication keychain name string key index number send-lifetime start-time string
Treestart-time
String Length20 to 32
ConfigurableTrue
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
tolerance number
Description

Tolerance for receive keys

If tolerance is Z then all receive keys remain valid up to the configured/applicable end-time plus an additional Z seconds.

Contextsystem authentication keychain name string tolerance number
Treetolerance
Default0
Unitsseconds
Configurable True
Platforms7220 IXR-D3L, 7220 IXR-H2, 7220 IXR-D3, 7220 IXR-D2, 7220 IXR-D5, 7220 IXR-D1, 7220 IXR-D2L, 7250 IXR-10, 7250 IXR-10e, 7250 IXR-6e, 7250 IXR-6, 7220 IXR-H3
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 to 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
PlatformsSupported on all platforms
usable boolean
Description The value of this object indicates if the keychain is usable for authentication
Contextsystem authentication keychain name string usable boolean
Treeusable
ConfigurableFalse
PlatformsSupported on all platforms

banner

Description Contains configuration and state related to system banners
Contextsystem banner
Treebanner
ConfigurableTrue
PlatformsSupported on all platforms

login-banner string

Description Banner to display before a user has authenticated
Contextsystem banner login-banner string
Treelogin-banner
ConfigurableTrue
PlatformsSupported on all platforms

motd-banner string

Description Banner to display after a user has authenticated
Contextsystem banner motd-banner string
Treemotd-banner
ConfigurableTrue
PlatformsSupported on all platforms

boot

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

autoboot

Description Top-level container for configuration and state data related to autobooting the system
Contextsystem boot autoboot
Treeautoboot
ConfigurableTrue
PlatformsSupported on all platforms
admin-state keyword
Description Administratively enable or disable autoboot functionality
Contextsystem boot autoboot admin-state keyword
Treeadmin-state
Options
  • enable

  • disable

Configurable True
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
mode string
Description Ztp operation modes. One or more modes can passed
Contextsystem boot autoboot mode string
Treemode
ConfigurableTrue
PlatformsSupported on all platforms
oper-state string
Description The current operational status of the autoboot process
Contextsystem boot autoboot oper-state string
Treeoper-state
ConfigurableFalse
PlatformsSupported on all platforms
timeout number
Description Sets the timeout for each attempt to autoboot
Contextsystem boot autoboot timeout number
Treetimeout
Range200 to 3600
Unitsseconds
ConfigurableTrue
PlatformsSupported on all platforms

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
PlatformsSupported on all platforms
Max. Elements3

bridge-table

Description system bridge-table information
Context system bridge-table
Treebridge-table
ConfigurableTrue
PlatformsSupported on all platforms

mac-limit

Description Bridge Table size and thresholds.
Context system bridge-table mac-limit
Treemac-limit
ConfigurableTrue
PlatformsSupported on all platforms
warning-threshold-pct number
Description Percentage of the configured max-number-macs over which a warning is triggered. The warning message is cleared when the percentage drops below the configured percentage minus 5%
Contextsystem bridge-table mac-limit warning-threshold-pct number
Treewarning-threshold-pct
ConfigurableFalse
PlatformsSupported on all platforms

proxy-arp

Description system bridge-table proxy ARP entry information
Contextsystem bridge-table proxy-arp
Treeproxy-arp
ConfigurableFalse
PlatformsSupported on all platforms
statistics
Description Enter the statistics context
Context system bridge-table proxy-arp statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
neighbor-origin origin keyword
Description The origin of the proxy entry installed in the table.
Contextsystem bridge-table proxy-arp statistics neighbor-origin origin keyword
Treeneighbor-origin
ConfigurableFalse
PlatformsSupported on all platforms

proxy-nd

Description system bridge-table proxy ND entry information
Contextsystem bridge-table proxy-nd
Treeproxy-nd
ConfigurableFalse
PlatformsSupported on all platforms
statistics
Description Enter the statistics context
Context system bridge-table proxy-nd statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
neighbor-origin origin keyword
Description The origin of the proxy entry installed in the table.
Contextsystem bridge-table proxy-nd statistics neighbor-origin origin keyword
Treeneighbor-origin
ConfigurableFalse
PlatformsSupported on all platforms

statistics

Description Enter the statistics context
Context system bridge-table statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
mac-type type keyword
Description The MAC type in the system.
Context system bridge-table statistics mac-type type keyword
Treemac-type
ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms

clock

Description Top-level container for system clock configuration and state
Contextsystem clock
Treeclock
ConfigurableTrue
PlatformsSupported on all platforms

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
PlatformsSupported on all platforms

configuration

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

auto-checkpoint boolean

Description Configuration checkpoint will be automatically created after every successful commit (if set to true).
Contextsystem configuration auto-checkpoint boolean
Treeauto-checkpoint
Defaultfalse
ConfigurableTrue
PlatformsSupported on all platforms

candidate name string

Description List of configuration candidates currently active
Contextsystem configuration candidate name string
Treecandidate
ConfigurableFalse
PlatformsSupported on all platforms
name string
Description Name of the configuration candidate
Context system configuration candidate name string
String Length1 to 255
ConfigurableFalse
PlatformsSupported on all platforms
type keyword
Description Type of configuration candidate
Context system configuration candidate name string type keyword
Treetype
Options
  • shared

  • private

Configurable False
PlatformsSupported on all platforms

checkpoint id number

Description List of current checkpoints present in the system
Contextsystem configuration checkpoint id number
Treecheckpoint
ConfigurableFalse
PlatformsSupported on all platforms
id number
Description System generated ID for the checkpoint
Contextsystem configuration checkpoint id number
ConfigurableFalse
PlatformsSupported on all platforms
size number
Description Size of the checkpoint configuration file
Contextsystem configuration checkpoint id number size number
Treesize
Unitsbytes
ConfigurableFalse
PlatformsSupported on all platforms
tag string
Description Full system version that the checkpoint was generated on
Contextsystem configuration checkpoint id number tag string
Treetag
ConfigurableFalse
PlatformsSupported on all platforms

commit id number

Description List of configuration transactions
Context system configuration commit id number
Treecommit
ConfigurableFalse
PlatformsSupported on all platforms
id number
Description System identifier for the commit
Context system configuration commit id number
ConfigurableFalse
PlatformsSupported on all platforms
comment string
Description Operator provided comment associated with this commit
Contextsystem configuration commit id number comment string
Treecomment
ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
started string
Description Start date and time of the commit
Context system configuration commit id number started string
Treestarted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms

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
PlatformsSupported on all platforms

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
PlatformsSupported on all platforms

max-candidates number

Description The maximum number of combined private and shared candidates
Contextsystem configuration max-candidates number
Treemax-candidates
Range1 to 255
Default10
ConfigurableTrue
PlatformsSupported on all platforms

role name reference

Description List of roles configured in the system
Contextsystem configuration role name reference
Treerole
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements32
rule path-reference string
Description List of paths to perform access control against
Contextsystem configuration role name reference rule path-reference string
Treerule
ConfigurableTrue
PlatformsSupported on all platforms
Max. Elements256
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
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms

session id number

Description List of configuration sessions currently active
Contextsystem configuration session id number
Treesession
ConfigurableFalse
PlatformsSupported on all platforms
id number
Description System generated ID for the configuration session
Contextsystem configuration session id number
ConfigurableFalse
PlatformsSupported on all platforms
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
PlatformsSupported on all platforms
started string
Description Start date and time of the configuration session
Contextsystem configuration session id number started string
Treestarted
String Length20 to 32
ConfigurableFalse
PlatformsSupported on all platforms
type keyword
Description Type of configuration session
Context system configuration session id number type keyword
Treetype
Options
  • shared

  • private

Configurable False
PlatformsSupported on all platforms
username string
Description User that started the configuration session
Contextsystem configuration session id number username string
Treeusername
String Length1 to 255
ConfigurableFalse
PlatformsSupported on all platforms

dhcp-server

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

admin-state keyword

Description Globally 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
PlatformsSupported on all platforms

network-instance name reference

Description List of network instances to run a dhcp server in
Contextsystem dhcp-server network-instance name reference
Treenetwork-instance
ConfigurableTrue
PlatformsSupported on all platforms
dhcpv4
Description Enter the dhcpv4 context
Context system dhcp-server network-instance name reference dhcpv4
Treedhcpv4
ConfigurableTrue
PlatformsSupported on all platforms
oper-state keyword
Description Details 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.

  • waiting

    Component or process is currently waiting

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

ConfigurableFalse
PlatformsSupported on all platforms
options
Description Enter the options context
Context system dhcp-server network-instance name reference dhcpv4 options
Treeoptions
ConfigurableTrue
PlatformsSupported on all platforms
server-id string
Description IP 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 - option 54
Contextsystem dhcp-server network-instance name reference dhcpv4 options server-id string
Treeserver-id
ConfigurableTrue
PlatformsSupported on all platforms
static-allocation
Description Enter the static-allocation context
Context system dhcp-server network-instance name reference dhcpv4 static-allocation
Treestatic-allocation
ConfigurableTrue
PlatformsSupported on all platforms
host mac string
Description Host name for static ip allocations
Context system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string
Treehost
ConfigurableTrue
PlatformsSupported on all platforms
options
Description Enter the options context
Context system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options
Treeoptions
ConfigurableTrue
PlatformsSupported on all platforms
statistics
Description Enter the statistics context
Context system dhcp-server network-instance name reference dhcpv4 statistics
Treestatistics
ConfigurableFalse
PlatformsSupported on all platforms
trace-options
Description Container for tracing DHCP server operations instance
Contextsystem dhcp-server network-instance name reference dhcpv4 trace-options
Treetrace-options
ConfigurableTrue
PlatformsSupported on all platforms