system
system
+ aaa
+ accounting
+ accounting-method reference
+ event event-type identityref
+ record identityref
+ authentication
+ admin-user
- failed-login-attempts number
- last-failed-login string
- last-successful-login string
- lockout
- active boolean
- end string
- start string
+ password string
- password-change-required boolean
- 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
- failed-login-attempts number
- last-failed-login string
- last-successful-login string
- lockout
- active boolean
- end string
- start string
+ password string
- password-change-required boolean
+ role reference
+ ssh-key string
+ authorization
+ role rolename string
+ cli
+ allow-command-list string
+ deny-command-list string
+ load-global-plugins boolean
+ load-user-plugins boolean
+ 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
+ radius
+ acct-port number
+ auth-port number
+ retransmit-attempts number
+ secret-key string
- 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
- active-key-for-send (keyword | reference)
+ 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
- golden-image string
- 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
+ license id string
+ admin-state keyword
+ data string
+ description string
- expiration-date string
- expired boolean
- in-use boolean
- issued-date string
+ preferred boolean
- valid boolean
+ 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
+ source-address (ipv4-address | ipv6-address)
+ 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
+ evpn
+ dynamic-label-block reference
+ network-instance
+ dynamic-label-block reference
+ static-label-block reference
+ mtu
+ default-ip-mtu number
+ default-l2-mtu number
+ default-mpls-mtu number
+ default-port-mtu number
+ min-path-mtu number
+ multicast
+ multicast-ids
- statistics
- current-usage number
- maximum-ids number
- multicast-id-user-type user keyword
- current-usage number
- total-pending number
- total-pending number
- multicast-forwarding-information-base
- multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address)
- last-update string
- line-card-replication-index number
+ name
+ domain-name string
+ host-name string
+ network-instance
+ protocols
+ bgp-vpn
+ bgp-instance id number
- oper-down-reason keyword
+ route-distinguisher
- rd (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
- 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 (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
- 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 (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
+ 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
+ source-address (ipv4-address | ipv6-address)
- 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
+ host-key
+ preserve boolean
+ 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-reference keyword
- freq-clock-state keyword
- freq-offset decimal-number
+ network-type keyword
+ ql-input-threshold keyword
+ ql-selection boolean
+ revert boolean
- system-ql-value keyword
+ wait-to-restore number
+ freq-references
+ instance instance-number number
+ admin-state keyword
- not-qualified-reason keyword
- oper-state keyword
+ priority number
+ ql-override keyword
- ql-value keyword
- reference-status keyword
+ underlying-interface string
+ one-pps
+ admin-state keyword
+ ptp
+ instance instance-index number
- current-ds
- mean-delay number
- offset-from-master number
- steps-removed number
+ default-ds
+ announce-receipt-timeout number
- clock-identity binary
- clock-quality
- clock-accuracy number
- clock-class number
- offset-scaled-log-variance number
- current-time
- time-nano-seconds number
- time-seconds number
+ domain-number number
- events
- delay-packet-loss number
- delay-too-much-pdv-time number
- sync-packet-loss number
- sync-too-much-pdv-time number
+ instance-enable boolean
+ instance-type keyword
+ local-priority number
+ log-announce-interval number
- number-ports number
+ priority1 number
+ priority2 number
- 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
- discards
- alternate-master number
- bad-domain number
- other number
- out-of-sequence number
- follow-up-msg-rx number
- follow-up-msg-tx number
- multicast-msg-rate
- anno-msg-rate-rx decimal-number
- anno-msg-rate-tx decimal-number
- del-req-msg-rate-rx decimal-number
- del-req-msg-rate-tx decimal-number
- del-resp-msg-rate-rx decimal-number
- del-resp-msg-rate-tx decimal-number
- follow-up-msg-rate-rx decimal-number
- follow-up-msg-rate-tx decimal-number
- other-rate-rx decimal-number
- sync-msg-rate-rx decimal-number
- sync-msg-rate-tx decimal-number
- other-rx number
- sync-msg-rx number
- sync-msg-tx number
- time-recovery-engine
- algorithm-state keyword
- last-adjustment number
- last-adjustment-timestamp string
- state-last-changed string
- statistics
- time-in-acquiring number
- time-in-holdover number
- time-in-initial number
- time-in-locked number
- 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
- parent-port-identity
- clock-identity binary
- port-number number
- protocol-address
- mac-address string
- network-protocol identityref
+ port-ds-list port-number number
+ admin-state keyword
- announce-receipt-timeout number
- asym-correction number
- best-master boolean
+ dest-mac keyword
- dynamic boolean
+ 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
- neighbor-count number
- neighbor-list clock-identity binary port-number number
- mac-address string
- rx-message-rate decimal-number
- parent-clock boolean
- port-state keyword
- 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
- discards
- alternate-master number
- bad-domain number
- other number
- out-of-sequence number
- follow-up-msg-rx number
- follow-up-msg-tx number
- other-rx number
- sync-msg-rx number
- sync-msg-tx number
+ underlying-transport
+ ethernet-port string
- 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-reference 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
aaa
| Description | Top-level container for AAA services | |
| Context | system aaa | |
| Tree | aaa | |
| Configurable | True | |
| Platforms | Supported on all platforms |
accounting
| Description | Top-level container for accounting | |
| Context | system aaa accounting | |
| Tree | accounting | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa accounting accounting-method reference | |
| Tree | accounting-method | |
| Reference | system aaa server-group name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
event event-type identityref
| Description | List of events subject to accounting | |
| Context | system aaa accounting event event-type identityref | |
| Tree | event | |
| Configurable | True | |
| Platforms | Supported on all platforms |
event-type identityref
| Description | The type of activity to record at the accounting server | |
| Context | system aaa accounting event event-type identityref | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
record identityref
| Description | Type of record to send to the accounting server for this activity type | |
| Context | system aaa accounting event event-type identityref record identityref | |
| Tree | record | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
authentication
| Description | Top-level container for global authentication data | |
| Context | system aaa authentication | |
| Tree | authentication | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-user
| Description | Enclosing container for admin user | |
| Context | system aaa authentication admin-user | |
| Tree | admin-user | |
| Configurable | True | |
| Platforms | Supported on all platforms |
failed-login-attempts number
| Description | Number of failed login attempts from the user | |
| Context | system aaa authentication admin-user failed-login-attempts number | |
| Tree | failed-login-attempts | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-failed-login string
| Description | The date and time of the last login failure from this user | |
| Context | system aaa authentication admin-user last-failed-login string | |
| Tree | last-failed-login | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-successful-login string
| Description | The date and time of the last successful login from this user | |
| Context | system aaa authentication admin-user last-successful-login string | |
| Tree | last-successful-login | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
lockout
| Description | Information relating to the lockout state of this user | |
| Context | system aaa authentication admin-user lockout | |
| Tree | lockout | |
| Configurable | False | |
| Platforms | Supported on all platforms |
active boolean
| Description | Indicates if a lockout is active for the user Lockouts can occur after successive failed logins, and can be cleared by 'tools system aaa authentication user <username> unlock' | |
| Context | system aaa authentication admin-user lockout active boolean | |
| Tree | active | |
| Configurable | False | |
| Platforms | Supported on all platforms |
end string
| Description | Indicates the time at which the most recent lockout for this user ended or will end | |
| Context | system aaa authentication admin-user lockout end string | |
| Tree | end | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
start string
| Description | Indicates the time at which the most recent lockout for this user started | |
| Context | system aaa authentication admin-user lockout start string | |
| Tree | start | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
password string
| Description | The admin password, supplied either as cleartext or as a hashed value If provided as cleartext, the system will hash the value on input, storing only the hashed value. If provided as a hashed value, the value should include any '$' characters, for example '$ar2$aOvsuj0ALlU=$r750fMa3ZEA/Di8dIfU2fQ=='. | |
| Context | system aaa authentication admin-user password string | |
| Tree | password | |
| Default | $ar2$aOvsuj0ALlU=$r750fMa3ZEA/Di8dIfU2fQ== | |
| Configurable | True | |
| Platforms | Supported on all platforms |
password-change-required boolean
| Description | Indicates if the user must change their password on next login | |
| Context | system aaa authentication admin-user password-change-required boolean | |
| Tree | password-change-required | |
| Configurable | False | |
| Platforms | Supported on all platforms |
username string
| Description | Assigned username for admin user | |
| Context | system aaa authentication admin-user username string | |
| Tree | username | |
| Default | admin | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authentication-method reference
| Description | Ordered list of server-groups to be used during user authentication If authentication fails with one method, the next defined method is tried -- failure of all methods results in the user being denied access. | |
| Context | system aaa authentication authentication-method reference | |
| Tree | authentication-method | |
| Reference | system aaa server-group name string | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa authentication exit-on-reject boolean | |
| Tree | exit-on-reject | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa authentication idle-timeout number | |
| Tree | idle-timeout | |
| Default | 600 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
linuxadmin-user
| Description | Enclosing container for linuxadmin user | |
| Context | system aaa authentication linuxadmin-user | |
| Tree | linuxadmin-user | |
| Configurable | True | |
| Platforms | Supported on all platforms |
password string
| Description | The linuxadmin password, supplied either as cleartext or as a hashed value If provided as cleartext, the system will hash the value on input, storing only the hashed value. If provided as a hashed value, the value should include any '$' characters, for example '$6$c66a15569d3f5952$kA2WPt9iqR5uMbaCUBNxsjKyXROQFdJtV1HX0CFY9wk7F326/yB3h.dERX9cH7YpeJ1N872hjzTb2tlaZFwwg0'. | |
| Context | system aaa authentication linuxadmin-user password string | |
| Tree | password | |
| Default | $6$c66a15569d3f5952$kA2WPt9iqR5uMbaCUBNxsjKyXROQFdJtV1HX0CFY9wk7F326/yB3h.dERX9cH7YpeJ1N872hjzTb2tlaZFwwg0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
username string
| Description | Assigned username for linuxadmin user | |
| Context | system aaa authentication linuxadmin-user username string | |
| Tree | username | |
| Default | linuxadmin | |
| Configurable | False | |
| Platforms | Supported on all platforms |
password
| Description | Top-level container for policies around user passwords | |
| Context | system aaa authentication password | |
| Tree | password | |
| Configurable | True | |
| Platforms | Supported on all platforms |
aging number
change-on-first-login boolean
| Description | Enable or disable a user being forced to change their password on first time login | |
| Context | system aaa authentication password change-on-first-login boolean | |
| Tree | change-on-first-login | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
complexity-rules
| Description | Top-level container for password complexity rules | |
| Context | system aaa authentication password complexity-rules | |
| Tree | complexity-rules | |
| Configurable | True | |
| Platforms | Supported on all platforms |
allow-username boolean
| Description | Enable or disable using username as part of the user password | |
| Context | system aaa authentication password complexity-rules allow-username boolean | |
| Tree | allow-username | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
maximum-length number
| Description | The maximum length of the password for local users, including admin and linuxadmin | |
| Context | system aaa authentication password complexity-rules maximum-length number | |
| Tree | maximum-length | |
| Range | 1 to 1023 | |
| Default | 1023 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
minimum-length number
| Description | The minimum length of the password for local users, including admin and linuxadmin | |
| Context | system aaa authentication password complexity-rules minimum-length number | |
| Tree | minimum-length | |
| Range | 1 to 12 | |
| Default | 1 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
minimum-lowercase number
| Description | The minimum lowercase characters from (a-z) that the user password must include A value of 0 results in no minimum-lowercase being enforced. | |
| Context | system aaa authentication password complexity-rules minimum-lowercase number | |
| Tree | minimum-lowercase | |
| Range | 0 to 10 | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
minimum-numeric number
| Description | The minimum numeric digits that the user password must include A value of 0 results in no minimum-numeric being enforced. | |
| Context | system aaa authentication password complexity-rules minimum-numeric number | |
| Tree | minimum-numeric | |
| Range | 0 to 10 | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
minimum-special-character number
| Description | The minimum special characters that the user password must include A value of 0 results in no minimum-special-character being enforced. | |
| Context | system aaa authentication password complexity-rules minimum-special-character number | |
| Tree | minimum-special-character | |
| Range | 0 to 10 | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
minimum-uppercase number
| Description | The minimum uppercase characters from (A-Z) that the user password must include A value of 0 results in no minimum-uppercase being enforced. | |
| Context | system aaa authentication password complexity-rules minimum-uppercase number | |
| Tree | minimum-uppercase | |
| Range | 0 to 10 | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
history number
lockout-policy
| Description | Top-level container for lockout policy | |
| Context | system aaa authentication password lockout-policy | |
| Tree | lockout-policy | |
| Configurable | True | |
| Platforms | Supported on all platforms |
attempts number
| Description | The number of failed login attempts that will lock the account A value of 0 means unlimited number of failed login attempts is allowed | |
| Context | system aaa authentication password lockout-policy attempts number | |
| Tree | attempts | |
| Range | 0 to 64 | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported 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 user account will be locked out/disabled indefinitely | |
| Context | system aaa authentication password lockout-policy lockout number | |
| Tree | lockout | |
| Range | 0 to 1440 | |
| Default | 15 | |
| Units | minutes | |
| Configurable | True | |
| Platforms | Supported on all platforms |
time number
| Description | The time period in minutes within which the failed login attempts occur | |
| Context | system aaa authentication password lockout-policy time number | |
| Tree | time | |
| Range | 0 to 1440 | |
| Default | 1 | |
| Units | minutes | |
| Configurable | True | |
| Platforms | Supported on all platforms |
session id number
| Description | List of active sessions in the system | |
| Context | system aaa authentication session id number | |
| Tree | session | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id number
| Description | System generated session ID | |
| Context | system aaa authentication session id number | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authentication-method string
| Description | Authentication method that authorized the user (the server-group name or local) | |
| Context | system aaa authentication session id number authentication-method string | |
| Tree | authentication-method | |
| Configurable | False | |
| Platforms | Supported on all platforms |
login-time string
| Description | Time the user logged in | |
| Context | system aaa authentication session id number login-time string | |
| Tree | login-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
priv-lvl number
remote-host string
| Description | Remote host of the session | |
| Context | system aaa authentication session id number remote-host string | |
| Tree | remote-host | |
| Configurable | False | |
| Platforms | Supported on all platforms |
service-name string
| Description | Service name that called login for the session | |
| Context | system aaa authentication session id number service-name string | |
| Tree | service-name | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tty-name string
username string
user username string
| Description | List of local users configured on the system | |
| Context | system aaa authentication user username string | |
| Tree | user | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 128 |
username string
| Description | Assigned username for this user | |
| Context | system aaa authentication user username string | |
| String Length | 1 to 32 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
failed-login-attempts number
| Description | Number of failed login attempts from the user | |
| Context | system aaa authentication user username string failed-login-attempts number | |
| Tree | failed-login-attempts | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-failed-login string
| Description | The date and time of the last login failure from this user | |
| Context | system aaa authentication user username string last-failed-login string | |
| Tree | last-failed-login | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-successful-login string
| Description | The date and time of the last successful login from this user | |
| Context | system aaa authentication user username string last-successful-login string | |
| Tree | last-successful-login | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
lockout
| Description | Information relating to the lockout state of this user | |
| Context | system aaa authentication user username string lockout | |
| Tree | lockout | |
| Configurable | False | |
| Platforms | Supported on all platforms |
active boolean
| Description | Indicates if a lockout is active for the user Lockouts can occur after successive failed logins, and can be cleared by 'tools system aaa authentication user <username> unlock' | |
| Context | system aaa authentication user username string lockout active boolean | |
| Tree | active | |
| Configurable | False | |
| Platforms | Supported on all platforms |
end string
start string
password string
| Description | The user password, supplied either as cleartext or as a hashed value If provided as cleartext, the system will hash the value on input, storing only the hashed value. If provided as a hashed value, the value should include any '$' characters, for example '$ar2$aOvsuj0ALlU=$r750fMa3ZEA/Di8dIfU2fQ=='. | |
| Context | system aaa authentication user username string password string | |
| Tree | password | |
| Configurable | True | |
| Platforms | Supported on all platforms |
password-change-required boolean
| Description | Indicates if the user must change their password on next login | |
| Context | system aaa authentication user username string password-change-required boolean | |
| Tree | password-change-required | |
| Configurable | False | |
| Platforms | Supported 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. | |
| Context | system aaa authentication user username string role reference | |
| Tree | role | |
| Reference | system aaa authorization role rolename string | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
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. | |
| Context | system aaa authentication user username string ssh-key string | |
| Tree | ssh-key | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
authorization
| Description | Top-level container for authorization configuration and operational state data | |
| Context | system aaa authorization | |
| Tree | authorization | |
| Configurable | True | |
| Platforms | Supported on all platforms |
role rolename string
| Description | List of local roles configured on the system | |
| Context | system aaa authorization role rolename string | |
| Tree | role | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rolename string
| Description | Assigned rolename for this role | |
| Context | system aaa authorization role rolename string | |
| String Length | 1 to 32 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
cli
| Description | Top-level container for cli plugin configuration | |
| Context | system aaa authorization role rolename string cli | |
| Tree | cli | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
allow-command-list string
| Description | List of cli commands the are allowed for this role Python style regular expressions are supported. Every item is left anchored (it matches from the beginning of line). Empty allow-command-list means anything that is not in deny-command-list is allowed. If both lists are empty then everything is allowed. | |
| Context | system aaa authorization role rolename string cli allow-command-list string | |
| Tree | allow-command-list | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 | |
| Max. Elements | 100 |
deny-command-list string
| Description | List of cli commands the are denied for this role Python style regular expressions are supported. Every item is left anchored (it matches from the beginning of line). Empty deny-command-list means anything that is not in allow-command-list is denied. If both lists are empty then everything is allowed. | |
| Context | system aaa authorization role rolename string cli deny-command-list string | |
| Tree | deny-command-list | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 | |
| Max. Elements | 100 |
load-global-plugins boolean
| Description | Specifies whether cli should load plugins from global plugin directory (from /etc/opt/srlinux/cli/plugins/). | |
| Context | system aaa authorization role rolename string cli load-global-plugins boolean | |
| Tree | load-global-plugins | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
load-user-plugins boolean
| Description | Specifies whether cli should load plugins from user home directory (from ~/cli/plugins/). | |
| Context | system aaa authorization role rolename string cli load-user-plugins boolean | |
| Tree | load-user-plugins | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
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. | |
| Context | system aaa authorization role rolename string services keyword | |
| Tree | services | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
tacacs
| Description | Top-level container for configuration relating to TACACS+ interworking with roles | |
| Context | system aaa authorization role rolename string tacacs | |
| Tree | tacacs | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa authorization role rolename string tacacs priv-lvl number | |
| Tree | priv-lvl | |
| Range | 0 to 15 | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa server-group name string | |
| Tree | server-group | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 3 |
name string
| Description | User defined name for the server group | |
| Context | system aaa server-group name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa server-group name string priv-lvl-authorization boolean | |
| Tree | priv-lvl-authorization | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported 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 | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) | |
| Tree | server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 5 |
address (ipv4-address | ipv6-address)
name string
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. | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
radius
| Description | Top-level container for RADIUS server data | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) radius | |
| Tree | radius | |
| Configurable | True | |
| Platforms | Supported on all platforms |
acct-port number
auth-port number
retransmit-attempts number
| Description | Number of times the system may resend a request to the RADIUS server when it is unresponsive | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) radius retransmit-attempts number | |
| Tree | retransmit-attempts | |
| Default | 3 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
secret-key string
| Description | The unencrypted shared key used between the authentication server and the device. | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) radius secret-key string | |
| Tree | secret-key | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enclosing container for server statistics | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
accounting-connection-failures number
| Description | Number of accounting connection failures | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics accounting-connection-failures number | |
| Tree | accounting-connection-failures | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
accounting-rejects number
| Description | Number of accounting rejections | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics accounting-rejects number | |
| Tree | accounting-rejects | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
accounting-success number
| Description | Number of accounting successes | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics accounting-success number | |
| Tree | accounting-success | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authorization-connection-failures number
| Description | Number of authorization connection failures | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics authorization-connection-failures number | |
| Tree | authorization-connection-failures | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authorization-rejects number
| Description | Number of authorization rejections | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics authorization-rejects number | |
| Tree | authorization-rejects | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authorization-success number
| Description | Number of authorization successes | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics authorization-success number | |
| Tree | authorization-success | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
login-connection-failures number
| Description | Number of login connection failures | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics login-connection-failures number | |
| Tree | login-connection-failures | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
login-rejects number
| Description | Number of login rejections | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics login-rejects number | |
| Tree | login-rejects | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
login-success number
| Description | Number of login successes | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) statistics login-success number | |
| Tree | login-success | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tacacs
| Description | Top-level container for TACACS+ server data | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) tacacs | |
| Tree | tacacs | |
| Configurable | True | |
| Platforms | Supported on all platforms |
port number
secret-key string
| Description | The unencrypted shared key used between the system and server | |
| Context | system aaa server-group name string server address (ipv4-address | ipv6-address) tacacs secret-key string | |
| Tree | secret-key | |
| Configurable | True | |
| Platforms | Supported on all platforms |
timeout number
type identityref
| Description | AAA server type -- all servers in the group must be of this type | |
| Context | system aaa server-group name string type identityref | |
| Tree | type | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
app-management
| Description | Top-level container for application configuration and state | |
| Context | system app-management | |
| Tree | app-management | |
| Configurable | False | |
| Platforms | Supported on all platforms |
application name string
| Description | List of all applications managed by the application manager | |
| Context | system app-management application name string | |
| Tree | application | |
| Configurable | False | |
| Platforms | Supported on all platforms |
name string
| Description | Unique name of this application instance | |
| Context | system app-management application name string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
author string
| Description | The author of the application | |
| Context | system app-management application name string author string | |
| Tree | author | |
| Configurable | False | |
| Platforms | Supported on all platforms |
cgroup string
| Description | Cgroup in with this application is started | |
| Context | system app-management application name string cgroup string | |
| Tree | cgroup | |
| Configurable | False | |
| Platforms | Supported 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 | |
| Context | system app-management application name string failure-action string | |
| Tree | failure-action | |
| Configurable | False | |
| Platforms | Supported 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 | |
| Context | system app-management application name string failure-threshold number | |
| Tree | failure-threshold | |
| Range | 0 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
failure-window number
| Description | Sliding window in seconds, over which to count restarts towards failure-threshold | |
| Context | system app-management application name string failure-window number | |
| Tree | failure-window | |
| Range | 300 to 86400 | |
| Units | seconds | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-change string
| Description | Date and time the application instance last changed state | |
| Context | system app-management application name string last-change string | |
| Tree | last-change | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-start-type keyword
| Description | Indicates the type of the most recent start or restart of this application instance | |
| Context | system app-management application name string last-start-type keyword | |
| Tree | last-start-type | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
launch-command string
| Description | The command used to launch the application | |
| Context | system app-management application name string launch-command string | |
| Tree | launch-command | |
| Configurable | False | |
| Platforms | Supported on all platforms |
oom-score-adj number
| Description | OOM score adj value set for this application | |
| Context | system app-management application name string oom-score-adj number | |
| Tree | oom-score-adj | |
| Configurable | False | |
| Platforms | Supported on all platforms |
path string
| Description | The directory where the application can be found | |
| Context | system app-management application name string path string | |
| Tree | path | |
| Configurable | False | |
| Platforms | Supported on all platforms |
pid number
| Description | Process ID of this application instance | |
| Context | system app-management application name string pid number | |
| Tree | pid | |
| Configurable | False | |
| Platforms | Supported on all platforms |
restricted-operations keyword
| Description | The operations that may not be manually performed on this application | |
| Context | system app-management application name string restricted-operations keyword | |
| Tree | restricted-operations | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
search-command string
| Description | The command used to search for the applications liveness | |
| Context | system app-management application name string search-command string | |
| Tree | search-command | |
| Configurable | False | |
| Platforms | Supported on all platforms |
state keyword
| Description | Current state of this application instance | |
| Context | system app-management application name string state keyword | |
| Tree | state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
statistics
| Description | Top-level container for application statistics | |
| Context | system app-management application name string statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
restart-count number
| Description | The number of times this application instance has restarted | |
| Context | system app-management application name string statistics restart-count number | |
| Tree | restart-count | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
supported-restart-types keyword
| Description | Indicates the supported restart types for this application | |
| Context | system app-management application name string supported-restart-types keyword | |
| Tree | supported-restart-types | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
version string
| Description | The version of the application | |
| Context | system app-management application name string version string | |
| Tree | version | |
| Configurable | False | |
| Platforms | Supported on all platforms |
yang
| Description | Top-level container for application state related to YANG | |
| Context | system app-management application name string yang | |
| Tree | yang | |
| Configurable | False | |
| Platforms | Supported on all platforms |
modules string
| Description | YANG module names used by this application instance | |
| Context | system app-management application name string yang modules string | |
| Tree | modules | |
| Configurable | False | |
| Platforms | Supported on all platforms |
source-directories string
| Description | Source directories searched for YANG modules to load These directories are used to load modules indicated in the modules leaf, and any modules imported/included within them | |
| Context | system app-management application name string yang source-directories string | |
| Tree | source-directories | |
| Configurable | False | |
| Platforms | Supported on all platforms |
authentication
| Description | Container for protocol authentication options available system wide | |
| Context | system authentication | |
| Tree | authentication | |
| Configurable | True | |
| Platforms | Supported on all platforms |
keychain name string
| Description | List of system keychains | |
| Context | system authentication keychain name string | |
| Tree | keychain | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 1024 |
name string
| Description | The user configured name for the keychain | |
| Context | system authentication keychain name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
active-key-for-send (keyword | reference)
| Description | Provides the key index of the currently active Keychain key | |
| Context | system authentication keychain name string active-key-for-send (keyword | reference) | |
| Tree | active-key-for-send | |
| Options |
| |
| Reference | system authentication keychain name string key index number | |
| Configurable | False | |
| Platforms | Supported 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: | |
| Context | system authentication keychain name string admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
description string
| Description | The user configured description for the keychain | |
| Context | system authentication keychain name string description string | |
| Tree | description | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
expired boolean
key index number
| Description | List of keys in the keychain | |
| Context | system authentication keychain name string key index number | |
| Tree | key | |
| Configurable | True | |
| Platforms | Supported on all platforms |
index number
algorithm keyword
| Description | The cryptographic algorithm used with the keying material to secure the messages | |
| Context | system authentication keychain name string key index number algorithm keyword | |
| Tree | algorithm | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
authentication-key string
| Description | The secret key The maximum string length is 32 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. | |
| Context | system authentication keychain name string key index number authentication-key string | |
| Tree | authentication-key | |
| String Length | 1 to 32 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
receive-lifetime
| Description | Enter the receive-lifetime context | |
| Context | system authentication keychain name string key index number receive-lifetime | |
| Tree | receive-lifetime | |
| Configurable | True | |
| Platforms | keychain |
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) | |
| Tree | end-time | |
| String Length | 20 to 32 | |
| Options |
| |
| Configurable | True | |
| Platforms | keychain |
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 | |
| Context | system authentication keychain name string key index number receive-lifetime start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | True | |
| Platforms | keychain |
send-lifetime
| Description | Specifies the lifetime of the key for sending authentication information to the peer | |
| Context | system authentication keychain name string key index number send-lifetime | |
| Tree | send-lifetime | |
| Configurable | True | |
| Platforms | keychain |
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). | |
| Context | system authentication keychain name string key index number send-lifetime send-and-receive boolean | |
| Tree | send-and-receive | |
| Configurable | True | |
| Platforms | keychain |
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 | |
| Context | system authentication keychain name string key index number send-lifetime start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | True | |
| Platforms | keychain |
tolerance number
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. | |
| Context | system authentication keychain name string type keyword | |
| Tree | type | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
usable boolean
banner
| Description | Contains configuration and state related to system banners | |
| Context | system banner | |
| Tree | banner | |
| Configurable | True | |
| Platforms | Supported on all platforms |
login-banner string
| Description | Banner to display before a user has authenticated | |
| Context | system banner login-banner string | |
| Tree | login-banner | |
| Configurable | True | |
| Platforms | Supported on all platforms |
motd-banner string
| Description | Banner to display after a user has authenticated | |
| Context | system banner motd-banner string | |
| Tree | motd-banner | |
| Configurable | True | |
| Platforms | Supported on all platforms |
boot
| Description | Top-level container for configuration and state data related to booting the system | |
| Context | system boot | |
| Tree | boot | |
| Configurable | True | |
| Platforms | Supported on all platforms |
autoboot
| Description | Top-level container for configuration and state data related to autobooting the system | |
| Context | system boot autoboot | |
| Tree | autoboot | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable autoboot functionality | |
| Context | system boot autoboot admin-state keyword | |
| Tree | admin-state | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
attempts number
client-id keyword
interface reference
mode string
oper-state string
| Description | The current operational status of the autoboot process | |
| Context | system boot autoboot oper-state string | |
| Tree | oper-state | |
| Configurable | False | |
| Platforms | Supported on all platforms |
timeout number
golden-image string
| Description | The local image the system reverts to when a factory reset operation is requested The value is the folder that contains the initramfs, kernel, and squashfs image. The search path for these directories is /mnt/nokiaos/<folder> | |
| Context | system boot golden-image string | |
| Tree | golden-image | |
| String Length | 1 to 255 | |
| Configurable | False | |
| Platforms | Supported 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> | |
| Context | system boot image string | |
| Tree | image | |
| String Length | 1 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms | |
| Max. Elements | 3 |
bridge-table
| Description | system bridge-table information | |
| Context | system bridge-table | |
| Tree | bridge-table | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mac-learning
| Description | Enter the mac-learning context | |
| Context | system bridge-table mac-learning | |
| Tree | mac-learning | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mac-relearn-only boolean
| Description | The value of this leaf indicates that the system will not learn any new mac addresses, but will relearn any that are already programmed | |
| Context | system bridge-table mac-learning mac-relearn-only boolean | |
| Tree | mac-relearn-only | |
| Configurable | False | |
| Platforms | Supported on all platforms |
mac-limit
| Description | Bridge Table size and thresholds. | |
| Context | system bridge-table mac-limit | |
| Tree | mac-limit | |
| Configurable | True | |
| Platforms | Supported on all platforms |
maximum-entries number
| Description | Maximum number of mac addresses allowed in the system bridge-table. | |
| Context | system bridge-table mac-limit maximum-entries number | |
| Tree | maximum-entries | |
| Configurable | False | |
| Platforms | Supported 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% | |
| Context | system bridge-table mac-limit warning-threshold-pct number | |
| Tree | warning-threshold-pct | |
| Configurable | False | |
| Platforms | Supported on all platforms |
proxy-arp
| Description | system bridge-table proxy ARP entry information | |
| Context | system bridge-table proxy-arp | |
| Tree | proxy-arp | |
| Configurable | False | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system bridge-table proxy-arp statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of active proxy entries. | |
| Context | system bridge-table proxy-arp statistics active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
in-active-entries number
| Description | The total number of inactive proxy entries. | |
| Context | system bridge-table proxy-arp statistics in-active-entries number | |
| Tree | in-active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
neighbor-origin origin keyword
| Description | the origin of the proxy entry installed in the table. | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword | |
| Tree | neighbor-origin | |
| Configurable | False | |
| Platforms | Supported on all platforms |
origin keyword
| Description | Enter the origin context | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of active proxy entries. | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
in-active-entries number
| Description | The total number of inactive proxy entries. | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword in-active-entries number | |
| Tree | in-active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
pending-entries number
| Description | The total number of pending proxy entries. | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword pending-entries number | |
| Tree | pending-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of proxy entries. | |
| Context | system bridge-table proxy-arp statistics neighbor-origin origin keyword total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
pending-entries number
| Description | The total number of pending proxy entries. | |
| Context | system bridge-table proxy-arp statistics pending-entries number | |
| Tree | pending-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of proxy entries. | |
| Context | system bridge-table proxy-arp statistics total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
proxy-nd
| Description | system bridge-table proxy ND entry information | |
| Context | system bridge-table proxy-nd | |
| Tree | proxy-nd | |
| Configurable | False | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system bridge-table proxy-nd statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of active proxy entries. | |
| Context | system bridge-table proxy-nd statistics active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
in-active-entries number
| Description | The total number of inactive proxy entries. | |
| Context | system bridge-table proxy-nd statistics in-active-entries number | |
| Tree | in-active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
neighbor-origin origin keyword
| Description | the origin of the proxy entry installed in the table. | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword | |
| Tree | neighbor-origin | |
| Configurable | False | |
| Platforms | Supported on all platforms |
origin keyword
| Description | Enter the origin context | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of active proxy entries. | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
in-active-entries number
| Description | The total number of inactive proxy entries. | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword in-active-entries number | |
| Tree | in-active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
pending-entries number
| Description | The total number of pending proxy entries. | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword pending-entries number | |
| Tree | pending-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of proxy entries. | |
| Context | system bridge-table proxy-nd statistics neighbor-origin origin keyword total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
pending-entries number
| Description | The total number of pending proxy entries. | |
| Context | system bridge-table proxy-nd statistics pending-entries number | |
| Tree | pending-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of proxy entries. | |
| Context | system bridge-table proxy-nd statistics total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system bridge-table statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of macs that are active on the system. | |
| Context | system bridge-table statistics active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
failed-entries number
| Description | The total number of macs, which have not been programmed on atleast one slot | |
| Context | system bridge-table statistics failed-entries number | |
| Tree | failed-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
mac-type type keyword
| Description | the type of the mac in the system. | |
| Context | system bridge-table statistics mac-type type keyword | |
| Tree | mac-type | |
| Configurable | False | |
| Platforms | Supported on all platforms |
type keyword
| Description | Enter the type context | |
| Context | system bridge-table statistics mac-type type keyword | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
active-entries number
| Description | The total number of macs of this type on the system. | |
| Context | system bridge-table statistics mac-type type keyword active-entries number | |
| Tree | active-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
failed-entries number
| Description | The total number of macs of this type, which have not been programmed on atleast one slot | |
| Context | system bridge-table statistics mac-type type keyword failed-entries number | |
| Tree | failed-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of macs of this type , active and inactive, on the system. | |
| Context | system bridge-table statistics mac-type type keyword total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-entries number
| Description | The total number of macs, active and inactive, on the system. | |
| Context | system bridge-table statistics total-entries number | |
| Tree | total-entries | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
clock
| Description | Top-level container for system clock configuration and state | |
| Context | system clock | |
| Tree | clock | |
| Configurable | True | |
| Platforms | Supported on all platforms |
timezone keyword
| Description | The timezone to use for the system Based on IANAs Time Zone database | |
| Context | system clock timezone keyword | |
| Tree | timezone | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
configuration
| Description | Top-level container for configuration and state data related to the system configuration | |
| Context | system configuration | |
| Tree | configuration | |
| Configurable | True | |
| Platforms | Supported on all platforms |
auto-checkpoint boolean
| Description | Configuration checkpoint will be automatically created after every successful commit (if set to true). | |
| Context | system configuration auto-checkpoint boolean | |
| Tree | auto-checkpoint | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
candidate name string
| Description | List of configuration candidates currently active | |
| Context | system configuration candidate name string | |
| Tree | candidate | |
| Configurable | False | |
| Platforms | Supported on all platforms |
name string
| Description | Name of the configuration candidate | |
| Context | system configuration candidate name string | |
| String Length | 1 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
started string
type keyword
username string
checkpoint id number
| Description | List of current checkpoints present in the system | |
| Context | system configuration checkpoint id number | |
| Tree | checkpoint | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id number
| Description | System generated ID for the checkpoint | |
| Context | system configuration checkpoint id number | |
| Configurable | False | |
| Platforms | Supported on all platforms |
comment string
| Description | User provided annotations associated with the checkpoint | |
| Context | system configuration checkpoint id number comment string | |
| Tree | comment | |
| Configurable | False | |
| Platforms | Supported on all platforms |
created string
| Description | Date and time this checkpoint was created | |
| Context | system configuration checkpoint id number created string | |
| Tree | created | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
name string
| Description | User provided name of the checkpoint | |
| Context | system configuration checkpoint id number name string | |
| Tree | name | |
| Configurable | False | |
| Platforms | Supported on all platforms |
size number
| Description | Size of the checkpoint configuration file | |
| Context | system configuration checkpoint id number size number | |
| Tree | size | |
| Units | bytes | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tag string
| Description | Full system version that the checkpoint was generated on | |
| Context | system configuration checkpoint id number tag string | |
| Tree | tag | |
| Configurable | False | |
| Platforms | Supported on all platforms |
username string
| Description | Username that created this checkpoint | |
| Context | system configuration checkpoint id number username string | |
| Tree | username | |
| String Length | 1 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
version string
| Description | System version that the checkpoint was generated on | |
| Context | system configuration checkpoint id number version string | |
| Tree | version | |
| Configurable | False | |
| Platforms | Supported on all platforms |
commit id number
| Description | List of configuration transactions | |
| Context | system configuration commit id number | |
| Tree | commit | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id number
| Description | System identifier for the commit | |
| Context | system configuration commit id number | |
| Configurable | False | |
| Platforms | Supported on all platforms |
comment string
ended string
name string
started string
status keyword
type keyword
username string
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. | |
| Context | system configuration idle-timeout number | |
| Tree | idle-timeout | |
| Default | 10080 | |
| Units | minutes | |
| Configurable | True | |
| Platforms | Supported 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. | |
| Context | system configuration last-change string | |
| Tree | last-change | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
max-candidates number
| Description | The maximum number of combined private and shared candidates | |
| Context | system configuration max-candidates number | |
| Tree | max-candidates | |
| Range | 1 to 255 | |
| Default | 10 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
max-checkpoints number
| Description | The number of checkpoints kept by the system | |
| Context | system configuration max-checkpoints number | |
| Tree | max-checkpoints | |
| Range | 1 to 255 | |
| Default | 10 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
role name reference
| Description | List of roles configured in the system | |
| Context | system configuration role name reference | |
| Tree | role | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 32 |
name reference
| Description | Enter the name context | |
| Context | system configuration role name reference | |
| Reference | system aaa authorization role rolename string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rule path-reference string
| Description | List of paths to perform access control against | |
| Context | system configuration role name reference rule path-reference string | |
| Tree | rule | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 256 |
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" | |
| Context | system configuration role name reference rule path-reference string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
action keyword
| Description | Action to allow for this path | |
| Context | system configuration role name reference rule path-reference string action keyword | |
| Tree | action | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
session id number
| Description | List of configuration sessions currently active | |
| Context | system configuration session id number | |
| Tree | session | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id number
| Description | System generated ID for the configuration session | |
| Context | system configuration session id number | |
| Configurable | False | |
| Platforms | Supported on all platforms |
exclusive boolean
name string
started string
type keyword
username string
dhcp-server
| Description | Configures the dhcp server | |
| Context | system dhcp-server | |
| Tree | dhcp-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Globally enable or disable the dhcp server Disabling this will disable all dhcp servers. | |
| Context | system dhcp-server admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance name reference
| Description | List of network instances to run a dhcp server in | |
| Context | system dhcp-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network instance | |
| Context | system dhcp-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcpv4
| Description | Enter the dhcpv4 context | |
| Context | system dhcp-server network-instance name reference dhcpv4 | |
| Tree | dhcpv4 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the dhcp server | |
| Context | system dhcp-server network-instance name reference dhcpv4 admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the dhcp server is operationally available | |
| Context | system dhcp-server network-instance name reference dhcpv4 oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
options
| Description | Enter the options context | |
| Context | system dhcp-server network-instance name reference dhcpv4 options | |
| Tree | options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bootfile-name string
| Description | The name of the configuration file the client will use during booting - option 67 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options bootfile-name string | |
| Tree | bootfile-name | |
| String Length | 1 to 128 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dns-server string
| Description | An Ordered List of DNS servers to return to the dhcp client - option 6 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options dns-server string | |
| Tree | dns-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
domain-name string
| Description | The domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System - option 15 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options domain-name string | |
| Tree | domain-name | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
hostname string
| Description | Host Name option of the dhcp client - option 12 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options hostname string | |
| Tree | hostname | |
| String Length | 1 to 63 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ntp-server string
| Description | List of NTP Servers to return to the dhcp client - option 42 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options ntp-server string | |
| Tree | ntp-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
router string
| Description | IPv4 address of the gateway for the dhcp client - option 3 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options router string | |
| Tree | router | |
| Configurable | True | |
| Platforms | Supported 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 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options server-id string | |
| Tree | server-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
tftp-server-address string
| Description | List of IP address of the TFTP servers the client will use to download bootfile/configuration script - option 150 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options tftp-server-address string | |
| Tree | tftp-server-address | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 2 |
tftp-server-name string
| Description | FQDN of the TFTP server the client will use to download bootfile/configuration script - option 66 | |
| Context | system dhcp-server network-instance name reference dhcpv4 options tftp-server-name string | |
| Tree | tftp-server-name | |
| String Length | 1 to 63 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
static-allocation
| Description | Enter the static-allocation context | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation | |
| Tree | static-allocation | |
| Configurable | True | |
| Platforms | Supported 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 | |
| Tree | host | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mac string
| Description | Enter the mac context | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ip-address string
| Description | Enter the ip-address context | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string ip-address string | |
| Tree | ip-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
options
| Description | Enter the options context | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options | |
| Tree | options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bootfile-name string
| Description | The name of the configuration file the client will use during booting - option 67 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options bootfile-name string | |
| Tree | bootfile-name | |
| String Length | 1 to 128 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dns-server string
| Description | An Ordered List of DNS servers to return to the dhcp client - option 6 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options dns-server string | |
| Tree | dns-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
domain-name string
| Description | The domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System - option 15 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options domain-name string | |
| Tree | domain-name | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
hostname string
| Description | Host Name option of the dhcp client - option 12 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options hostname string | |
| Tree | hostname | |
| String Length | 1 to 63 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ntp-server string
| Description | List of NTP Servers to return to the dhcp client - option 42 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options ntp-server string | |
| Tree | ntp-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
router string
| Description | IPv4 address of the gateway for the dhcp client - option 3 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options router string | |
| Tree | router | |
| Configurable | True | |
| Platforms | Supported 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 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options server-id string | |
| Tree | server-id | |
| Configurable | True | |
| Platforms | Supported on all platforms |
tftp-server-address string
| Description | List of IP address of the TFTP servers the client will use to download bootfile/configuration script - option 150 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options tftp-server-address string | |
| Tree | tftp-server-address | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 2 |
tftp-server-name string
| Description | FQDN of the TFTP server the client will use to download bootfile/configuration script - option 66 | |
| Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options tftp-server-name string | |
| Tree | tftp-server-name | |
| String Length | 1 to 63 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name reference dhcpv4 statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
client-packets-discarded number
| Description | Total discarded dhcp packets from dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv4 statistics client-packets-discarded number | |
| Tree | client-packets-discarded | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
client-packets-received number
| Description | Total received dhcp packets from dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv4 statistics client-packets-received number | |
| Tree | client-packets-received | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
server-packets-sent number
| Description | Total dhcp packets sent from DHCP server towards dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv4 statistics server-packets-sent number | |
| Tree | server-packets-sent | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
trace-options
| Description | Container for tracing DHCP server operations instance | |
| Context | system dhcp-server network-instance name reference dhcpv4 trace-options | |
| Tree | trace-options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trace keyword
| Description | List of events to trace | |
| Context | system dhcp-server network-instance name reference dhcpv4 trace-options trace keyword | |
| Tree | trace | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
dhcpv6
| Description | Enter the dhcpv6 context | |
| Context | system dhcp-server network-instance name reference dhcpv6 | |
| Tree | dhcpv6 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the dhcp server | |
| Context | system dhcp-server network-instance name reference dhcpv6 admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the dhcp server is operationally available | |
| Context | system dhcp-server network-instance name reference dhcpv6 oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
options
| Description | Enter the options context | |
| Context | system dhcp-server network-instance name reference dhcpv6 options | |
| Tree | options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dns-server string
| Description | An Ordered List of DNS servers to return to the dhcp client | |
| Context | system dhcp-server network-instance name reference dhcpv6 options dns-server string | |
| Tree | dns-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
static-allocation
| Description | Enter the static-allocation context | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation | |
| Tree | static-allocation | |
| Configurable | True | |
| Platforms | Supported on all platforms |
host mac string
| Description | host name for static ip allocations | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string | |
| Tree | host | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mac string
| Description | Enter the mac context | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ip-address string
| Description | Enter the ip-address context | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string ip-address string | |
| Tree | ip-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
options
| Description | Enter the options context | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string options | |
| Tree | options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
dns-server string
| Description | An Ordered List of DNS servers to return to the dhcp client | |
| Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string options dns-server string | |
| Tree | dns-server | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 4 |
statistics
| Description | Enter the statistics context | |
| Context | system dhcp-server network-instance name reference dhcpv6 statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
client-packets-discarded number
| Description | Total discarded dhcp packets from dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv6 statistics client-packets-discarded number | |
| Tree | client-packets-discarded | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
client-packets-received number
| Description | Total received dhcp packets from dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv6 statistics client-packets-received number | |
| Tree | client-packets-received | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
server-packets-sent number
| Description | Total dhcp packets sent from DHCP server towards dhcp client(s) | |
| Context | system dhcp-server network-instance name reference dhcpv6 statistics server-packets-sent number | |
| Tree | server-packets-sent | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
trace-options
| Description | Container for tracing DHCP server operations instance | |
| Context | system dhcp-server network-instance name reference dhcpv6 trace-options | |
| Tree | trace-options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trace keyword
| Description | List of events to trace | |
| Context | system dhcp-server network-instance name reference dhcpv6 trace-options trace keyword | |
| Tree | trace | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
dns
| Description | Top-level container for DNS configuration and state | |
| Context | system dns | |
| Tree | dns | |
| Configurable | True | |
| Platforms | Supported on all platforms |
host-entry name string
| Description | List of static host entries | |
| Context | system dns host-entry name string | |
| Tree | host-entry | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Name of host entry | |
| Context | system dns host-entry name string | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ipv4-address string
| Description | IPv4 address for the host entry | |
| Context | system dns host-entry name string ipv4-address string | |
| Tree | ipv4-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ipv6-address string
| Description | IPv6 address for the host entry | |
| Context | system dns host-entry name string ipv6-address string | |
| Tree | ipv6-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance reference
| Description | Reference to a configured network-instance to source DNS requests from | |
| Context | system dns network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of the DNS client | |
| Context | system dns oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
search-list string
| Description | An ordered list of domains to search when resolving a host name | |
| Context | system dns search-list string | |
| Tree | search-list | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
server-list (ipv4-address | ipv6-address)
| Description | List of the DNS servers that the resolver should query | |
| Context | system dns server-list (ipv4-address | ipv6-address) | |
| Tree | server-list | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 3 |
event-handler
| Description | Top-level container for configuration and state of event handler and event handling instances | |
| Context | system event-handler | |
| Tree | event-handler | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
instance name string
| Description | List of all event handler instances An event handler instance consists of a set of paths to be monitored for changes, and a Python script to execute if changes occur. | |
| Context | system event-handler instance name string | |
| Tree | instance | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 | |
| Max. Elements | 20 |
name string
| Description | A user-defined name for this event handler instance | |
| Context | system event-handler instance name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
admin-state keyword
| Description | Administratively enable or disable this event handler instance | |
| Context | system event-handler instance name string admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
last-errored-execution
| Description | Operational state of the last errored execution of this instance | |
| Context | system event-handler instance name string last-errored-execution | |
| Tree | last-errored-execution | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
end-time string
| Description | The time this instance last finished execution This timestamp includes any actions provided as output from the execution | |
| Context | system event-handler instance name string last-errored-execution end-time string | |
| Tree | end-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
input string
| Description | The input provided to the script | |
| Context | system event-handler instance name string last-errored-execution input string | |
| Tree | input | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
oper-down-reason keyword
| Description | The reason this instance is or was in its last operational state | |
| Context | system event-handler instance name string last-errored-execution oper-down-reason keyword | |
| Tree | oper-down-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
oper-down-reason-detail string
| Description | Any additional detail event handler can provide around the last operational state of this instance | |
| Context | system event-handler instance name string last-errored-execution oper-down-reason-detail string | |
| Tree | oper-down-reason-detail | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
output string
| Description | The output received from the script If empty, no response was received. | |
| Context | system event-handler instance name string last-errored-execution output string | |
| Tree | output | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
start-time string
| Description | The time this instance last started execution | |
| Context | system event-handler instance name string last-errored-execution start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
stdout-stderr string
| Description | The output printed on STDOUT or STDERR during this execution | |
| Context | system event-handler instance name string last-errored-execution stdout-stderr string | |
| Tree | stdout-stderr | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
upython-duration number
| Description | Time taken for the instance to return output | |
| Context | system event-handler instance name string last-errored-execution upython-duration number | |
| Tree | upython-duration | |
| Units | microseconds | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
last-execution
| Description | Operational state of the last execution of this instance | |
| Context | system event-handler instance name string last-execution | |
| Tree | last-execution | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
end-time string
| Description | The time this instance last finished execution This timestamp includes any actions provided as output from the execution | |
| Context | system event-handler instance name string last-execution end-time string | |
| Tree | end-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
input string
| Description | The input provided to the script | |
| Context | system event-handler instance name string last-execution input string | |
| Tree | input | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
oper-down-reason keyword
| Description | The reason this instance is or was in its last operational state | |
| Context | system event-handler instance name string last-execution oper-down-reason keyword | |
| Tree | oper-down-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
oper-down-reason-detail string
| Description | Any additional detail event handler can provide around the last operational state of this instance | |
| Context | system event-handler instance name string last-execution oper-down-reason-detail string | |
| Tree | oper-down-reason-detail | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
output string
| Description | The output received from the script If empty, no response was received. | |
| Context | system event-handler instance name string last-execution output string | |
| Tree | output | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
start-time string
| Description | The time this instance last started execution | |
| Context | system event-handler instance name string last-execution start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
stdout-stderr string
| Description | The output printed on STDOUT or STDERR during this execution | |
| Context | system event-handler instance name string last-execution stdout-stderr string | |
| Tree | stdout-stderr | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
upython-duration number
| Description | Time taken for the instance to return output | |
| Context | system event-handler instance name string last-execution upython-duration number | |
| Tree | upython-duration | |
| Units | microseconds | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
oper-state keyword
| Description | Details if this event handler instance is operationally available | |
| Context | system event-handler instance name string oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
options
| Description | Options to be passed on each execution of the script | |
| Context | system event-handler instance name string options | |
| Tree | options | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
object name string
| Description | Enter the object list instance | |
| Context | system event-handler instance name string options object name string | |
| Tree | object | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
name string
| Description | The name of this object | |
| Context | system event-handler instance name string options object name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
value string
| Description | A single value to associate with this object | |
| Context | system event-handler instance name string options object name string value string | |
| Tree | value | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
values string
| Description | List of values to associate with this object, these are serialized as a JSON array when provided as input to the script | |
| Context | system event-handler instance name string options object name string values string | |
| Tree | values | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
paths string
| Description | List of valid YANG paths in CLI notation to monitor for changes If any events are received on any of the provided paths, the configured script will be executed. This path may include keys, wildcards, ranges, and other management server supported constructs. E.g. "interface * oper-state" "acl ipv4-filter foo* description" | |
| Context | system event-handler instance name string paths string | |
| Tree | paths | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 | |
| Max. Elements | 36 |
statistics
| Description | Top-level container for event handler statistics | |
| Context | system event-handler instance name string statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
execution-count number
| Description | Indicates the total number of executions of this script | |
| Context | system event-handler instance name string statistics execution-count number | |
| Tree | execution-count | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
execution-errors number
| Description | Indicates the total number of errors in executions of this script | |
| Context | system event-handler instance name string statistics execution-errors number | |
| Tree | execution-errors | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
execution-successes number
| Description | Indicates the total number of successful executions of this script | |
| Context | system event-handler instance name string statistics execution-successes number | |
| Tree | execution-successes | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
execution-timeouts number
| Description | Indicates the total number of timeouts in executions of this script | |
| Context | system event-handler instance name string statistics execution-timeouts number | |
| Tree | execution-timeouts | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
upython-duration number
| Description | Total time taken for all executions of this script to return output | |
| Context | system event-handler instance name string statistics upython-duration number | |
| Tree | upython-duration | |
| Units | milliseconds | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
upython-script string
| Description | File name of a MicroPython script, including .py suffix This script should exist in /etc/opt/srlinux/eventmgr or /opt/srlinux/eventmgr already. Explicit paths outside of these two directories are not permitted. | |
| Context | system event-handler instance name string upython-script string | |
| Tree | upython-script | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
run-as-user reference
| Description | The user to run event handler instances as If no user is configured, scripts are executed as the 'admin' user. | |
| Context | system event-handler run-as-user reference | |
| Tree | run-as-user | |
| Reference | system aaa authentication user username string | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
features string
ftp-server
| Description | Top-level container for FTP server configuration and state | |
| Context | system ftp-server | |
| Tree | ftp-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance name reference
| Description | List of network-instances to run an FTP server in | |
| Context | system ftp-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network-instance | |
| Context | system ftp-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enables or disables the FTP server in this network-instance | |
| Context | system ftp-server network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of the FTP server | |
| Context | system ftp-server network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
session-limit number
| Description | Set a limit on the number of simultaneous active FTP sessions | |
| Context | system ftp-server network-instance name reference session-limit number | |
| Tree | session-limit | |
| Default | 20 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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'. | |
| Context | system ftp-server network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Default | :: | |
| Configurable | True | |
| Platforms | Supported on all platforms |
timeout number
| Description | Set the idle timeout in seconds on FTP connections | |
| Context | system ftp-server network-instance name reference timeout number | |
| Tree | timeout | |
| Default | 300 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
gnmi-server
| Description | Configures the gNMI server access API | |
| Context | system gnmi-server | |
| Tree | gnmi-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Globally enable or disable the gNMI server Disabling this will disable all gNMI servers. | |
| Context | system gnmi-server admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
commit-confirmed-timeout number
| Description | Number of seconds to wait for confirmation. A value of 0 means commit confirmed is not used | |
| Context | system gnmi-server commit-confirmed-timeout number | |
| Tree | commit-confirmed-timeout | |
| Range | 0 to 86400 | |
| Default | 0 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
commit-save boolean
| Description | Specifies whether to save startup configuration after every successful commit | |
| Context | system gnmi-server commit-save boolean | |
| Tree | commit-save | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
include-defaults-in-config-only-responses boolean
| Description | Specifies whether to include field default values in get/subscribe responses when using configuration only datastore (for example running/intended datastore) | |
| Context | system gnmi-server include-defaults-in-config-only-responses boolean | |
| Tree | include-defaults-in-config-only-responses | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance name reference
| Description | List of network instances to run a gNMI server in | |
| Context | system gnmi-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network instance | |
| Context | system gnmi-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the gNMI server | |
| Context | system gnmi-server network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the gNMI server is operationally available | |
| Context | system gnmi-server network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
port number
| Description | Port the gNMI server will listen on for incoming connections | |
| Context | system gnmi-server network-instance name reference port number | |
| Tree | port | |
| Range | 0 to 65535 | |
| Default | 57400 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses the gNMI server will listen on within the network instance | |
| Context | system gnmi-server network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Default | :: | |
| Configurable | True | |
| Platforms | Supported on all platforms |
tls-profile reference
| Description | Reference to the TLS profile to use on the gNMI server | |
| Context | system gnmi-server network-instance name reference tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every gNMI request | |
| Context | system gnmi-server network-instance name reference use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
yang-models keyword
| Description | Specify yang-models to be used when origin field is not present in the gnmi requests | |
| Context | system gnmi-server network-instance name reference yang-models keyword | |
| Tree | yang-models | |
| Default | native | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
rate-limit number
| Description | Set a limit on the number of connection attempts per minute | |
| Context | system gnmi-server rate-limit number | |
| Tree | rate-limit | |
| Range | 0 to 65535 | |
| Default | 60 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
session-limit number
| Description | Set a limit on the number of simultaneous active gNMI sessions | |
| Context | system gnmi-server session-limit number | |
| Tree | session-limit | |
| Range | 0 to 65535 | |
| Default | 20 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subscription id number
| Description | List of subscriptions | |
| Context | system gnmi-server subscription id number | |
| Tree | subscription | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id number
| Description | System generated ID for for the subscription | |
| Context | system gnmi-server subscription id number | |
| Range | 0 to 4294967295 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
mode keyword
| Description | Subscription mode (ON_CHANGE, SAMPLE, TARGET_DEFINED, POLL, ONCE) | |
| Context | system gnmi-server subscription id number mode keyword | |
| Tree | mode | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
paths string
| Description | List of paths being subscribed to | |
| Context | system gnmi-server subscription id number paths string | |
| Tree | paths | |
| Configurable | False | |
| Platforms | Supported on all platforms |
remote-host (ipv4-address | ipv6-address)
| Description | Remote host of the subscription | |
| Context | system gnmi-server subscription id number remote-host (ipv4-address | ipv6-address) | |
| Tree | remote-host | |
| Configurable | False | |
| Platforms | Supported on all platforms |
remote-port number
| Description | Remote port of the subscription | |
| Context | system gnmi-server subscription id number remote-port number | |
| Tree | remote-port | |
| Range | 0 to 65535 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
sample-interval number
| Description | Time in seconds to provide updates to the remote host, set to 0 for all subscription modes except SAMPLE | |
| Context | system gnmi-server subscription id number sample-interval number | |
| Tree | sample-interval | |
| Units | seconds | |
| Configurable | False | |
| Platforms | Supported on all platforms |
start-time string
| Description | Time of the subscription creation | |
| Context | system gnmi-server subscription id number start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
user string
| Description | Authenticated username for the subscription | |
| Context | system gnmi-server subscription id number user string | |
| Tree | user | |
| Configurable | False | |
| Platforms | Supported on all platforms |
user-agent string
| Description | User agent used for the subscription | |
| Context | system gnmi-server subscription id number user-agent string | |
| Tree | user-agent | |
| Configurable | False | |
| Platforms | Supported on all platforms |
timeout number
| Description | Set the idle timeout in seconds on gNMI connections | |
| Context | system gnmi-server timeout number | |
| Tree | timeout | |
| Range | 0 to 65535 | |
| Default | 7200 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trace-options keyword
| Description | gNMI trace options | |
| Context | system gnmi-server trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
unix-socket
| Description | Top-level container for configuration and state related to unix sockets | |
| Context | system gnmi-server unix-socket | |
| Tree | unix-socket | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the gNMI server | |
| Context | system gnmi-server unix-socket admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the gNMI server is operationally available | |
| Context | system gnmi-server unix-socket oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
socket-path string
| Description | Path to the unix socket used by gNMI | |
| Context | system gnmi-server unix-socket socket-path string | |
| Tree | socket-path | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tls-profile reference
| Description | Reference to the TLS profile to use on the gNMI unix socket server If none is specified, then TLS is not used. | |
| Context | system gnmi-server unix-socket tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every gNMI request | |
| Context | system gnmi-server unix-socket use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
yang-models keyword
| Description | Specify yang-models to be used when origin field is not present in the gnmi requests | |
| Context | system gnmi-server unix-socket yang-models keyword | |
| Tree | yang-models | |
| Default | native | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
gribi-server
| Description | Configures the gRPC Routing Information Base Interface (gRIBI) service | |
| Context | system gribi-server | |
| Tree | gribi-server | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
admin-state keyword
| Description | Globally enable or disable the gRIBI service Disabling this will disable all gRIBI sockets in all configured network-instances (including unix sockets). | |
| Context | system gribi-server admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
client id number
| Description | List of active gRIBI client sessions | |
| Context | system gribi-server client id number | |
| Tree | client | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
id number
| Description | System generated ID for for the client | |
| Context | system gribi-server client id number | |
| Range | 0 to 4294967295 | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
election-id string
| Description | Election ID of this client | |
| Context | system gribi-server client id number election-id string | |
| Tree | election-id | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
persistence-mode keyword
| Description | The defined persistence mode as signaled by the client | |
| Context | system gribi-server client id number persistence-mode keyword | |
| Tree | persistence-mode | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
remote-host (ipv4-address | ipv6-address)
| Description | Remote host of the client | |
| Context | system gribi-server client id number remote-host (ipv4-address | ipv6-address) | |
| Tree | remote-host | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
remote-port number
| Description | Remote port of the client | |
| Context | system gribi-server client id number remote-port number | |
| Tree | remote-port | |
| Range | 0 to 65535 | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
start-time string
| Description | Time the client first connected | |
| Context | system gribi-server client id number start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
user string
user-agent string
| Description | User agent used for by the client | |
| Context | system gribi-server client id number user-agent string | |
| Tree | user-agent | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
network-instance name reference
| Description | List of network instances to run a gRIBI socket in | |
| Context | system gribi-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
name reference
| Description | Reference to a configured network instance | |
| Context | system gribi-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
admin-state keyword
| Description | Administratively enable or disable the gRIBI service | |
| Context | system gribi-server network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
oper-state keyword
| Description | Details if the gRIBI service is operationally available | |
| Context | system gribi-server network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
port number
| Description | TCP port the gRIBI server will listen on for incoming connections | |
| Context | system gribi-server network-instance name reference port number | |
| Tree | port | |
| Range | 0 to 65535 | |
| Default | 57401 | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses the gRIBI server will listen on within the network instance By default the gRIBI server will listen on all addresses in the network-instance. | |
| Context | system gribi-server network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
tls-profile reference
| Description | Reference to the TLS profile to use on the gRIBI server | |
| Context | system gribi-server network-instance name reference tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every gRIBI RPC request | |
| Context | system gribi-server network-instance name reference use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
rate-limit number
| Description | Set a limit on the number of connection attempts per minute | |
| Context | system gribi-server rate-limit number | |
| Tree | rate-limit | |
| Range | 0 to 65535 | |
| Default | 60 | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
session-limit number
| Description | Set a limit on the number of simultaneous active gRIBI sessions A session is defined as an individual RPC invocation, which could result in a single client generating multiple sessions. | |
| Context | system gribi-server session-limit number | |
| Tree | session-limit | |
| Range | 0 to 65535 | |
| Default | 20 | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
timeout number
| Description | Set the idle timeout in seconds on gRIBI clients | |
| Context | system gribi-server timeout number | |
| Tree | timeout | |
| Range | 0 to 65535 | |
| Default | 7200 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
trace-options keyword
| Description | gRIBI trace options | |
| Context | system gribi-server trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
unix-socket
| Description | Top-level container for configuration and state related to unix sockets | |
| Context | system gribi-server unix-socket | |
| Tree | unix-socket | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
admin-state keyword
| Description | Administratively enable or disable the gRIBI service | |
| Context | system gribi-server unix-socket admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
oper-state keyword
| Description | Details if the gRIBI service is operationally available | |
| Context | system gribi-server unix-socket oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
socket-path string
| Description | Path to the unix socket used by gRIBI | |
| Context | system gribi-server unix-socket socket-path string | |
| Tree | socket-path | |
| Configurable | False | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
tls-profile reference
| Description | Reference to the TLS profile to use on the gRIBI unix socket server If none is specified, then TLS is not used. | |
| Context | system gribi-server unix-socket tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every gRIBI RPC request | |
| Context | system gribi-server unix-socket use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-6e, 7250 IXR-10e, 7250 IXR-6, 7250 IXR-10 |
information
| Description | Top-level container for system information configuration and state | |
| Context | system information | |
| Tree | information | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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. | |
| Context | system information contact string | |
| Tree | contact | |
| Configurable | True | |
| Platforms | Supported on all platforms |
current-datetime string
| Description | The current system date and time | |
| Context | system information current-datetime string | |
| Tree | current-datetime | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system information description string | |
| Tree | description | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-booted string
| Description | The date and time the system was last booted | |
| Context | system information last-booted string | |
| Tree | last-booted | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system information location string | |
| Tree | location | |
| Configurable | True | |
| Platforms | Supported on all platforms |
version string
| Description | The system version This field represents the version of the management server | |
| Context | system information version string | |
| Tree | version | |
| Configurable | False | |
| Platforms | Supported on all platforms |
json-rpc-server
| Description | Configures the JSON RPC access API | |
| Context | system json-rpc-server | |
| Tree | json-rpc-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Globally enable or disable the JSON RPC server Disabling this will disable all JSON RPC servers. | |
| Context | system json-rpc-server admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
commit-confirmed-timeout number
| Description | Number of seconds to wait for confirmation. A value of 0 means commit confirmed is not used | |
| Context | system json-rpc-server commit-confirmed-timeout number | |
| Tree | commit-confirmed-timeout | |
| Range | 0 to 86400 | |
| Default | 0 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance name reference
| Description | List of network instances to run the JSON RPC server in | |
| Context | system json-rpc-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network-instance | |
| Context | system json-rpc-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
http
| Description | Top-level container for the JSON RPC HTTP server | |
| Context | system json-rpc-server network-instance name reference http | |
| Tree | http | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the HTTP JSON RPC server This requires the JSON RPC server to be globally enabled | |
| Context | system json-rpc-server network-instance name reference http admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the JSON RPC server is operationally available | |
| Context | system json-rpc-server network-instance name reference http oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
port number
| Description | The port the HTTP JSON RPC server will listen on for incoming connections | |
| Context | system json-rpc-server network-instance name reference http port number | |
| Tree | port | |
| Range | 0 to 65535 | |
| Default | 80 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
session-limit number
| Description | The number of concurrent requests the server will allow If a request comes in while this limit is reached, the request will block until another request is finished. | |
| Context | system json-rpc-server network-instance name reference http session-limit number | |
| Tree | session-limit | |
| Range | 1 to 100 | |
| Default | 10 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses the JSON RPC server will listen on within the network instance | |
| Context | system json-rpc-server network-instance name reference http source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Default | :: | |
| Configurable | True | |
| Platforms | Supported on all platforms |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every JSON RPC request | |
| Context | system json-rpc-server network-instance name reference http use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
https
| Description | Top-level container for the JSON-RPC HTTPS server | |
| Context | system json-rpc-server network-instance name reference https | |
| Tree | https | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable the HTTPS JSON RPC server This requires the JSON RPC server to be globally enabled | |
| Context | system json-rpc-server network-instance name reference https admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the JSON RPC server is operationally available | |
| Context | system json-rpc-server network-instance name reference https oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
port number
| Description | Port the HTTPS JSON RPC server will listen on for incoming connections | |
| Context | system json-rpc-server network-instance name reference https port number | |
| Tree | port | |
| Range | 0 to 65535 | |
| Default | 443 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
session-limit number
| Description | The number of concurrent requests the server will allow If a request comes in while this limit is reached, the request will block until another request is finished. | |
| Context | system json-rpc-server network-instance name reference https session-limit number | |
| Tree | session-limit | |
| Range | 1 to 100 | |
| Default | 10 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses the JSON RPC server will listen on within the network instance | |
| Context | system json-rpc-server network-instance name reference https source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Default | :: | |
| Configurable | True | |
| Platforms | Supported on all platforms |
tls-profile reference
| Description | Reference to the TLS profile to use on the HTTP JSON RPC server | |
| Context | system json-rpc-server network-instance name reference https tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every JSON RPC request | |
| Context | system json-rpc-server network-instance name reference https use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trace-options keyword
| Description | JSON RPC trace options | |
| Context | system json-rpc-server trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
unix-socket
| Description | Top-level container for configuration and state related to unix sockets | |
| Context | system json-rpc-server unix-socket | |
| Tree | unix-socket | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Context | system json-rpc-server unix-socket admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details if the JSON RPC server is operationally available | |
| Context | system json-rpc-server unix-socket oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
socket-path string
| Description | Path to the unix socket used by JSON RPC | |
| Context | system json-rpc-server unix-socket socket-path string | |
| Tree | socket-path | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tls-profile reference
| Description | Reference to the TLS profile to use on the JSON RPC unix socket server If none is specified, then TLS is not used. | |
| Context | system json-rpc-server unix-socket tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every JSON RPC request | |
| Context | system json-rpc-server unix-socket use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
l2cp-transparency
| Description | Enclosing container for system level Layer-2 Control Protocol transparency. | |
| Context | system l2cp-transparency | |
| Tree | l2cp-transparency | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
l2cp-statistics
| Description | Container for Layer-2 Control Plane protocol statistics. | |
| Context | system l2cp-transparency l2cp-statistics | |
| Tree | l2cp-statistics | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
dot1x
| Description | Container for 802.1x protocols. | |
| Context | system l2cp-transparency l2cp-statistics dot1x | |
| Tree | dot1x | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-trap-to-cpu-packets number
| Description | System level incoming 802.1x frames copied to CPU. Cumulative of all Ethernet interfaces including all the copy-to-cpu 802.1x frames. 802.1x frames are identified by a destination MAC value of 01:80:c2:00:00:03 and EtherType value of 0x888e. | |
| Context | system l2cp-transparency l2cp-statistics dot1x in-trap-to-cpu-packets number | |
| Tree | in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-tunneled-packets number
| Description | System level incoming 802.1x tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled 802.1x frames. 802.1x frames are identified by a destination MAC value of 01:80:c2:00:00:03 and EtherType value of 0x888e. | |
| Context | system l2cp-transparency l2cp-statistics dot1x in-tunneled-packets number | |
| Tree | in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the LACP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics dot1x last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
lacp
| Description | Container for LACP. | |
| Context | system l2cp-transparency l2cp-statistics lacp | |
| Tree | lacp | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-trap-to-cpu-packets number
| Description | System level incoming Link Aggregation Control Protocol frames copied to CPU. Cumulative of all Ethernet interfaces including all the copy-to-cpu LACP frames. LACP frames are identified by a destination MAC value of 01:80:c2:00:00:02, EtherType value of 0x8809 and slow protocol subtype 0x1. | |
| Context | system l2cp-transparency l2cp-statistics lacp in-trap-to-cpu-packets number | |
| Tree | in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-tunneled-packets number
| Description | System level incoming Link Aggregation Control Protocol tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled LACP frames. LACP frames are identified by a destination MAC value of 01:80:c2:00:00:02, EtherType value of 0x8809 and slow protocol subtype 0x1. | |
| Context | system l2cp-transparency l2cp-statistics lacp in-tunneled-packets number | |
| Tree | in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the LACP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics lacp last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the L2CP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
lldp
| Description | Container for LLDP. | |
| Context | system l2cp-transparency l2cp-statistics lldp | |
| Tree | lldp | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-trap-to-cpu-packets number
| Description | System level incoming Link Layer Discovery Protocol frames copied to CPU. Cumulative of all Ethernet interfaces including all the copy-to-cpu LLDP frames. LLDP frames are identified by a destination MAC value of 01:80:c2:00:00:0e and EtherType value of 0x88cc. | |
| Context | system l2cp-transparency l2cp-statistics lldp in-trap-to-cpu-packets number | |
| Tree | in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-tunneled-packets number
| Description | System level incoming Link Layer Discovery Protocol tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled LLDP frames. LLDP frames are identified by a destination MAC value of 01:80:c2:00:00:0e and EtherType value of 0x88cc. | |
| Context | system l2cp-transparency l2cp-statistics lldp in-tunneled-packets number | |
| Tree | in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the LACP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics lldp last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
ptp
| Description | Container for Precision Time Protocol Peer-Delay protocol. | |
| Context | system l2cp-transparency l2cp-statistics ptp | |
| Tree | ptp | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-trap-to-cpu-packets number
| Description | System level incoming Precision Time Protocol Peer-Delay frames copied to CPU. Cumulative of all Ethernet interfaces including all the copy-to-cpu PTP frames. PTP frames are identified by a destination MAC value of 01:80:c2:00:00:0e and Ethertype value of 0x88F7. | |
| Context | system l2cp-transparency l2cp-statistics ptp in-trap-to-cpu-packets number | |
| Tree | in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-tunneled-packets number
| Description | System level incoming Precision Time Protocol Peer-Delay tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled PTP frames. PTP frames are identified by a destination MAC value of 01:80:c2:00:00:0e and Ethertype value of 0x88F7. | |
| Context | system l2cp-transparency l2cp-statistics ptp in-tunneled-packets number | |
| Tree | in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the PTP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics ptp last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
total-in-discarded-packets number
| Description | System level incoming L2CP discarded frames. Cumulative of all Ethernet interfaces including all the discarded L2CP frames. L2CP frames are identified by a destination MAC value of 01:80:c2:00:00:0X or 01:80:c2:00:00:2X, being X any value in the 0..F range. | |
| Context | system l2cp-transparency l2cp-statistics total-in-discarded-packets number | |
| Tree | total-in-discarded-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
total-in-packets number
| Description | System level total incoming L2CP frames. Cumulative of all Ethernet interfaces including the tunneled, discarded and copy-to-cpu L2CP frames. L2CP frames are identified by a destination MAC value of 01:80:c2:00:00:0X or 01:80:c2:00:00:2X, being X any value in the 0..F range. | |
| Context | system l2cp-transparency l2cp-statistics total-in-packets number | |
| Tree | total-in-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
total-in-trap-to-cpu-packets number
| Description | System level incoming L2CP copy-to-cpu frames. Cumulative of all Ethernet interfaces including all the L2CP frames that are copied to CPU. L2CP frames are identified by a destination MAC value of 01:80:c2:00:00:0X or 01:80:c2:00:00:2X, being X any value in the 0..F range. | |
| Context | system l2cp-transparency l2cp-statistics total-in-trap-to-cpu-packets number | |
| Tree | total-in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
total-in-tunneled-packets number
| Description | System level incoming L2CP tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled L2CP frames. L2CP frames are identified by a destination MAC value of 01:80:c2:00:00:0X or 01:80:c2:00:00:2X, being X any value in the 0..F range. | |
| Context | system l2cp-transparency l2cp-statistics total-in-tunneled-packets number | |
| Tree | total-in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
xstp
| Description | Container for Spanning Tree Protocols. | |
| Context | system l2cp-transparency l2cp-statistics xstp | |
| Tree | xstp | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-trap-to-cpu-packets number
| Description | System level incoming Spanning Tree Protocol frames copied to CPU. Cumulative of all Ethernet interfaces including all the copy-to-cpu Spanning Tree frames. Spanning Tree frames are identified by a destination MAC value of 01:80:c2:00:00:00 and LLC value 0x42. | |
| Context | system l2cp-transparency l2cp-statistics xstp in-trap-to-cpu-packets number | |
| Tree | in-trap-to-cpu-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
in-tunneled-packets number
| Description | System level incoming Spanning Tree tunneled frames. Cumulative of all Ethernet interfaces including all the tunneled Spanning Tree frames. xSTP frames are identified by a destination MAC value of 01:80:c2:00:00:00 and LLC value 0x42. | |
| Context | system l2cp-transparency l2cp-statistics xstp in-tunneled-packets number | |
| Tree | in-tunneled-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
last-clear string
| Description | Timestamp of the last time the xSTP counters were cleared. | |
| Context | system l2cp-transparency l2cp-statistics xstp last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
lacp
| Description | Enter the lacp context | |
| Context | system lacp | |
| Tree | lacp | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
system-id string
| Description | The MAC address portion of the node's System ID. This is combined with the system priority to construct the 8-octet system-id | |
| Context | system lacp system-id string | |
| Tree | system-id | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
system-priority number
| Description | System priority used by the node on this LAG interface. Lower value is higher priority for determining which node is the controlling system. | |
| Context | system lacp system-priority number | |
| Tree | system-priority | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
license id string
| Description | List of licenses configured on the system | |
| Context | system license id string | |
| Tree | license | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 | |
| Max. Elements | 5 |
id string
| Description | Unique identifier for this license | |
| Context | system license id string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
admin-state keyword
| Description | Enable or disable the use of this license | |
| Context | system license id string admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
data string
| Description | Content of the license This content includes a preceding UUID, followed by a space and the license data. For example: 00000000-0000-0000-0000-000000000000 aACUAx...rYzNRPT0AAAAA | |
| Context | system license id string data string | |
| Tree | data | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
description string
| Description | A user provided description for the license | |
| Context | system license id string description string | |
| Tree | description | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
expiration-date string
| Description | Date and time the license will expire | |
| Context | system license id string expiration-date string | |
| Tree | expiration-date | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
expired boolean
| Description | Indicates if the license has expired | |
| Context | system license id string expired boolean | |
| Tree | expired | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
in-use boolean
| Description | Indicates if the license is actively in use | |
| Context | system license id string in-use boolean | |
| Tree | in-use | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
issued-date string
| Description | Date and time the license was issued | |
| Context | system license id string issued-date string | |
| Tree | issued-date | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
preferred boolean
| Description | Set a license as being preferred Amongst all valid licenses, the preferred license will be chosen to become active. If no license is set as preferred or the preferred license is not valid, the valid license with the most distant expiry is chosen to become active. Only a single license can be set as preferred. | |
| Context | system license id string preferred boolean | |
| Tree | preferred | |
| Default | false | |
| Configurable | True | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
valid boolean
| Description | Indicates if the license is valid for use | |
| Context | system license id string valid boolean | |
| Tree | valid | |
| Configurable | False | |
| Platforms | 7250 IXR-6, 7220 IXR-D3L, 7220 IXR-D2, 7250 IXR-10, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7250 IXR-6e, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
lldp
| Description | Top-level container for LLDP configuration and state data | |
| Context | system lldp | |
| Tree | lldp | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enable or disable LLDP at the system level | |
| Context | system lldp admin-state keyword | |
| Tree | admin-state | |
| Default | enable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
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 | |
| Context | system lldp chassis-id string | |
| Tree | chassis-id | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp chassis-id-type keyword | |
| Tree | chassis-id-type | |
| Default | MAC_ADDRESS | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
hello-timer number
| Description | System level hello timer for the LLDP protocol | |
| Context | system lldp hello-timer number | |
| Tree | hello-timer | |
| Default | 30 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp hold-multiplier number | |
| Tree | hold-multiplier | |
| Default | 4 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
interface name reference
| Description | List of interfaces on which LLDP can be enabled | |
| Context | system lldp interface name reference | |
| Tree | interface | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
admin-state keyword
| Description | Enable or disable LLDP on the interface | |
| Context | system lldp interface name reference admin-state keyword | |
| Tree | admin-state | |
| Default | enable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
neighbor id string
| Description | List of LLDP neighbors on this interface | |
| Context | system lldp interface name reference neighbor id string | |
| Tree | neighbor | |
| Configurable | False | |
| Platforms | Supported on all platforms |
id string
capability name identityref
| Description | List of LLDP system capabilities advertised by the neighbor | |
| Context | system lldp interface name reference neighbor id string capability name identityref | |
| Tree | capability | |
| Configurable | False | |
| Platforms | Supported on all platforms |
name identityref
| 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. | |
| Context | system lldp interface name reference neighbor id string capability name identityref | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
enabled boolean
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 | |
| Context | system lldp interface name reference neighbor id string chassis-id string | |
| Tree | chassis-id | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp interface name reference neighbor id string chassis-id-type keyword | |
| Tree | chassis-id-type | |
| Default | MAC_ADDRESS | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
custom-tlv type number oui string oui-subtype string
| Description | List of custom LLDP TLVs from a neighbor | |
| Context | system lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string | |
| Tree | custom-tlv | |
| Configurable | False | |
| Platforms | Supported on all platforms |
type number
| Description | The integer value identifying the type of information contained in the value field. | |
| Context | system lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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]. | |
| Context | system lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp interface name reference neighbor id string custom-tlv type number oui string oui-subtype string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
value binary
first-message string
| Description | Date and time of the first message from neighbor | |
| Context | system lldp interface name reference neighbor id string first-message string | |
| Tree | first-message | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-update string
| Description | Date and time of the last update from neighbor | |
| Context | system lldp interface name reference neighbor id string last-update string | |
| Tree | last-update | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
management-address address string
| Description | List of management addresses received from the remote LLDP neighbor | |
| Context | system lldp interface name reference neighbor id string management-address address string | |
| Tree | management-address | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp interface name reference neighbor id string management-address address string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp interface name reference neighbor id string management-address address string type keyword | |
| Tree | type | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
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. | |
| Context | system lldp interface name reference neighbor id string port-description string | |
| Tree | port-description | |
| Configurable | False | |
| Platforms | Supported on all platforms |
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 | system lldp interface name reference neighbor id string port-id (string | binary) | |
| Tree | port-id | |
| Configurable | False | |
| Platforms | Supported on all platforms |
port-id-type keyword
| Description | The type of identifier used in the port-id field This field identifies the format and source of the port identifier string. It is an enumerator defined by the PtopoPortIdType object from RFC2922. | |
| Context | system lldp interface name reference neighbor id string port-id-type keyword | |
| Tree | port-id-type | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
system-description string
| Description | The system description of the remote neighbor The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field. | |
| Context | system lldp interface name reference neighbor id string system-description string | |
| Tree | system-description | |
| String Length | 0 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
system-name string
| Description | The administratively assigned name of the remote neighbor The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field. | |
| Context | system lldp interface name reference neighbor id string system-name string | |
| Tree | system-name | |
| String Length | 0 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of LLDP on the interface | |
| Context | system lldp interface name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
statistics
| Description | LLDP counters on each interface | |
| Context | system lldp interface name reference statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-discard number
| Description | The number of LLDP frames received and discarded | |
| Context | system lldp interface name reference statistics frame-discard number | |
| Tree | frame-discard | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-error-in number
| Description | The number of LLDP frames received with errors | |
| Context | system lldp interface name reference statistics frame-error-in number | |
| Tree | frame-error-in | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-error-out number
| Description | The number of frame transmit errors on the interface | |
| Context | system lldp interface name reference statistics frame-error-out number | |
| Tree | frame-error-out | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-in number
frame-out number
last-clear string
| Description | Indicates the last time the counters were cleared | |
| Context | system lldp interface name reference statistics last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tlv-discard number
| Description | The number of TLV frames received and discarded | |
| Context | system lldp interface name reference statistics tlv-discard number | |
| Tree | tlv-discard | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tlv-unknown number
| Description | The number of frames received with unknown TLV | |
| Context | system lldp interface name reference statistics tlv-unknown number | |
| Tree | tlv-unknown | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
management-address subinterface string
| Description | List of subinterfaces to source management addresses from This list is sent in the management address TLV by LLDP. | |
| Context | system lldp management-address subinterface string | |
| Tree | management-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subinterface string
| Description | Reference to the subinterface to source management addresses | |
| Context | system lldp management-address subinterface string | |
| String Length | 5 to 25 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
type keyword
| Description | Types of addresses sent in the management address TLV 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. | |
| Context | system lldp management-address subinterface string type keyword | |
| Tree | type | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Global LLDP counters | |
| Context | system lldp statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
entries-aged-out number
| Description | The number of entries aged out due to timeout. | |
| Context | system lldp statistics entries-aged-out number | |
| Tree | entries-aged-out | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-discard number
| Description | The number of LLDP frames received and discarded | |
| Context | system lldp statistics frame-discard number | |
| Tree | frame-discard | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-error-in number
| Description | The number of LLDP frames received with errors | |
| Context | system lldp statistics frame-error-in number | |
| Tree | frame-error-in | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-in number
| Description | The number of LLDP frames received | |
| Context | system lldp statistics frame-in number | |
| Tree | frame-in | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
frame-out number
| Description | The number of LLDP frames transmitted | |
| Context | system lldp statistics frame-out number | |
| Tree | frame-out | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-clear string
| Description | Indicates the last time the counters were cleared | |
| Context | system lldp statistics last-clear string | |
| Tree | last-clear | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tlv-accepted number
| Description | The number of valid TLVs received. | |
| Context | system lldp statistics tlv-accepted number | |
| Tree | tlv-accepted | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tlv-discard number
| Description | The number of TLV frames received and discarded | |
| Context | system lldp statistics tlv-discard number | |
| Tree | tlv-discard | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
tlv-unknown number
| Description | The number of frames received with unknown TLV | |
| Context | system lldp statistics tlv-unknown number | |
| Tree | tlv-unknown | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
system-description string
| Description | Field detailing system description, including name and versions The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. | |
| Context | system lldp system-description string | |
| Tree | system-description | |
| String Length | 0 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
system-name string
| Description | The systems administratively assigned name The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. | |
| Context | system lldp system-name string | |
| Tree | system-name | |
| String Length | 0 to 255 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
trace-options keyword
| Description | LLDP trace options | |
| Context | system lldp trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
load-balancing
| Description | Adjust system-wide ECMP load balancing options. | |
| Context | system load-balancing | |
| Tree | load-balancing | |
| Configurable | True | |
| Platforms | Supported on all platforms |
hash-options
| Description | Container for packet header fields and other inputs used in hashing calculations | |
| Context | system load-balancing hash-options | |
| Tree | hash-options | |
| Configurable | True | |
| Platforms | Supported on all platforms |
destination-address boolean
| Description | Include the destination IP address in the hash calculation | |
| Context | system load-balancing hash-options destination-address boolean | |
| Tree | destination-address | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
destination-port boolean
| Description | Include the destination TCP/UDP port number in the hash calculation if the packet is an unfragmented IP packet carrying a TCP/UDP payload | |
| Context | system load-balancing hash-options destination-port boolean | |
| Tree | destination-port | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
hash-seed number
| Description | A configured hash seed to override the default value of 0 Different routers can be configured with different hash-seed values to minimize traffic polarization effects. This hash-seed is used by all hash-related CRC calculations including those take IP header fields, those that take Ethernet header fields and those that take MPLS labels. | |
| Context | system load-balancing hash-options hash-seed number | |
| Tree | hash-seed | |
| Default | 0 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ipv6-flow-label boolean
| Description | Include the IPv6 flow label in the hash calculation if the packet is an IPv6 packet It is expected that the IPv6 flow label value is written by the server or other host originating the flow and not changed by any intermediate switch or router. | |
| Context | system load-balancing hash-options ipv6-flow-label boolean | |
| Tree | ipv6-flow-label | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
mpls-label-stack boolean
| Description | Include the received labels (terminated and non-terminated) in the hash calculation | |
| Context | system load-balancing hash-options mpls-label-stack boolean | |
| Tree | mpls-label-stack | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
protocol boolean
| Description | Include the IP protocol number in the hash calculation. For an IPv6 packet this is protocol value in the next-header field of the last extension header. | |
| Context | system load-balancing hash-options protocol boolean | |
| Tree | protocol | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address boolean
| Description | Include the source IP address in the hash calculation | |
| Context | system load-balancing hash-options source-address boolean | |
| Tree | source-address | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-port boolean
| Description | Include the source TCP/UDP port number in the hash calculation if the packet is an unfragmented IP packet carrying a TCP/UDP payload | |
| Context | system load-balancing hash-options source-port boolean | |
| Tree | source-port | |
| Default | true | |
| Configurable | True | |
| Platforms | Supported on all platforms |
vlan boolean
| Description | Include the received VLAN ID in the hash calculation | |
| Context | system load-balancing hash-options vlan boolean | |
| Tree | vlan | |
| Default | true | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-H4, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5, 7220 IXR-H2, 7220 IXR-H3 |
logging
| Description | System logging provides the interface to syslog services to setup output entities on a selection of log sources. | |
| Context | system logging | |
| Tree | logging | |
| Configurable | True | |
| Platforms | Supported on all platforms |
buffer buffer-name string
| Description | Log files maintained in memory, non-persistent across system reboots These files are stored at directory /var/log/srlinux/buffer. Rotation into multiple files is available. | |
| Context | system logging buffer buffer-name string | |
| Tree | buffer | |
| Configurable | True | |
| Platforms | Supported on all platforms |
buffer-name string
| Description | Base name of the file(s) to be stored in memory | |
| Context | system logging buffer buffer-name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility facility-name keyword
| Description | List of facilities to source messages from | |
| Context | system logging buffer buffer-name string facility facility-name keyword | |
| Tree | facility | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility-name keyword
| Description | Name of a Linux syslog facility | |
| Context | system logging buffer buffer-name string facility facility-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging buffer buffer-name string facility facility-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging buffer buffer-name string facility facility-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging buffer buffer-name string facility facility-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter reference
| Description | A set of all-matching criteria that messages must fulfill in order to be captured | |
| Context | system logging buffer buffer-name string filter reference | |
| Tree | filter | |
| Reference | system logging filter filter-name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
format string
| Description | Text format of the output syslog messages, in legacy syslog $template style | |
| Context | system logging buffer buffer-name string format string | |
| Tree | format | |
| Default | %TIMEGENERATED:::date-rfc3339% %HOSTNAME% %SYSLOGTAG%%MSG:::sp-if-no-1st-sp%%MSG:::drop-last-lf%\n | |
| Configurable | True | |
| Platforms | Supported on all platforms |
persist number
| Description | Time in seconds to shadow the buffer to persistent storage Setting this field to 0 results in the buffer not being persisted. A value other than 0 will result in the log being persisted to disk based on the configured value. Logs with a non-zero persist value are persisted automatically on rollover, or at the configured value. | |
| Context | system logging buffer buffer-name string persist number | |
| Tree | persist | |
| Range | 0 | 60 to 604800 | |
| Default | 0 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rotate number
rotations number
size string
| Description | Number of bytes an individual output file cannot exceed The field allows the 'K, M, or G' suffixes as shorthand. When reaching that size, a rotation happens and subsequent data is stored in a new file with the same base name. | |
| Context | system logging buffer buffer-name string size string | |
| Tree | size | |
| Default | 10M | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem subsystem-name keyword
| Description | Entity or entities that may produce messages to be captured | |
| Context | system logging buffer buffer-name string subsystem subsystem-name keyword | |
| Tree | subsystem | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem-name keyword
| Description | Reference to an available subsystem to source messages from | |
| Context | system logging buffer buffer-name string subsystem subsystem-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging buffer buffer-name string subsystem subsystem-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging buffer buffer-name string subsystem subsystem-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging buffer buffer-name string subsystem subsystem-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
console
| Description | Hardware serial device normally used for bring-up and diagnostics | |
| Context | system logging console | |
| Tree | console | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility facility-name keyword
| Description | List of facilities to source messages from | |
| Context | system logging console facility facility-name keyword | |
| Tree | facility | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility-name keyword
| Description | Name of a Linux syslog facility | |
| Context | system logging console facility facility-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging console facility facility-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging console facility facility-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging console facility facility-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter reference
format string
| Description | Text format of the output syslog messages, in legacy syslog $template style | |
| Context | system logging console format string | |
| Tree | format | |
| Default | %TIMEGENERATED:::date-rfc3339% %HOSTNAME% %SYSLOGTAG%%MSG:::sp-if-no-1st-sp%%MSG:::drop-last-lf%\n | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem subsystem-name keyword
| Description | Entity or entities that may produce messages to be captured | |
| Context | system logging console subsystem subsystem-name keyword | |
| Tree | subsystem | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem-name keyword
| Description | Reference to an available subsystem to source messages from | |
| Context | system logging console subsystem subsystem-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging console subsystem subsystem-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging console subsystem subsystem-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging console subsystem subsystem-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
file file-name string
| Description | Log files maintained on disk, persistent across system reboots When a maximum file size is reached, the file is renamed and a maximum rotate number of them are kept. | |
| Context | system logging file file-name string | |
| Tree | file | |
| Configurable | True | |
| Platforms | Supported on all platforms |
file-name string
directory string
facility facility-name keyword
| Description | List of facilities to source messages from | |
| Context | system logging file file-name string facility facility-name keyword | |
| Tree | facility | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility-name keyword
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging file file-name string facility facility-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging file file-name string facility facility-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging file file-name string facility facility-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter reference
format string
| Description | Text format of the output syslog messages, in legacy syslog $template style | |
| Context | system logging file file-name string format string | |
| Tree | format | |
| Default | %TIMEGENERATED:::date-rfc3339% %HOSTNAME% %SYSLOGTAG%%MSG:::sp-if-no-1st-sp%%MSG:::drop-last-lf%\n | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rotate number
rotations number
size string
| Description | Number of bytes an individual output file cannot exceed The field allows the 'K, M, or G' suffixes as shorthand. When reaching that size, a rotation happens and subsequent data is stored in a new file with the same base name. | |
| Context | system logging file file-name string size string | |
| Tree | size | |
| Default | 10M | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem subsystem-name keyword
| Description | Entity or entities that may produce messages to be captured | |
| Context | system logging file file-name string subsystem subsystem-name keyword | |
| Tree | subsystem | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem-name keyword
| Description | Reference to an available subsystem to source messages from | |
| Context | system logging file file-name string subsystem subsystem-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging file file-name string subsystem subsystem-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging file file-name string subsystem subsystem-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging file file-name string subsystem subsystem-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter filter-name string
| Description | Describes a set of critieria that captured messages are required to fulfill | |
| Context | system logging filter filter-name string | |
| Tree | filter | |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter-name string
| Description | Name of the filter | |
| Context | system logging filter filter-name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
contains string
facility facility-name keyword
| Description | List of facilities to source messages from | |
| Context | system logging filter filter-name string facility facility-name keyword | |
| Tree | facility | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility-name keyword
| Description | Name of a Linux syslog facility | |
| Context | system logging filter filter-name string facility facility-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging filter filter-name string facility facility-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging filter filter-name string facility facility-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging filter filter-name string facility facility-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
prefix string
regex string
tag string
network-instance reference
| Description | Reference to a configured network-instance to run rsyslogd in This network-instance will be used as a source for requests to remote syslog servers. | |
| Context | system logging network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
remote-server host (ipv4-address | ipv6-address | domain-name)
| Description | List of output remote syslog servers | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) | |
| Tree | remote-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
host (ipv4-address | ipv6-address | domain-name)
| Description | Domain or IP address of a remote syslog server destination | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility facility-name keyword
| Description | List of facilities to source messages from | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) facility facility-name keyword | |
| Tree | facility | |
| Configurable | True | |
| Platforms | Supported on all platforms |
facility-name keyword
| Description | Name of a Linux syslog facility | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) facility facility-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) facility facility-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) facility facility-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) facility facility-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
filter reference
| Description | A set of all-matching criteria that messages must fulfill in order to be captured | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) filter reference | |
| Tree | filter | |
| Reference | system logging filter filter-name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
remote-port number
| Description | Transport port for syslog to use for messages sent to a remote server | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) remote-port number | |
| Tree | remote-port | |
| Default | 514 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | Source address for syslog to use for messages sent to a remote server If no source address is provided, then packets will be sent to the remote server using the source address indicated by the routing table. | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem subsystem-name keyword
| Description | Entity or entities that may produce messages to be captured | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) subsystem subsystem-name keyword | |
| Tree | subsystem | |
| Configurable | True | |
| Platforms | Supported on all platforms |
subsystem-name keyword
| Description | Reference to an available subsystem to source messages from | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) subsystem subsystem-name keyword | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
priority
| Description | Narrows the capture to a given severity, a range or a specific set of severities | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) subsystem subsystem-name keyword priority | |
| Tree | priority | |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-above keyword
| Description | At a given severity and above | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) subsystem subsystem-name keyword priority match-above keyword | |
| Tree | match-above | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
match-exact keyword
| Description | Individually specified severities | |
| Context | system logging remote-server host (ipv4-address | ipv6-address | domain-name) subsystem subsystem-name keyword priority match-exact keyword | |
| Tree | match-exact | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
transport keyword
subsystem-facility keyword
| Description | Linux facility that internal application subsystems will use | |
| Context | system logging subsystem-facility keyword | |
| Tree | subsystem-facility | |
| Default | local6 | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
maintenance
| Description | Top-level container for Maintenance Mode configuration | |
| Context | system maintenance | |
| Tree | maintenance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
group name string
| Description | List of user-configured maintenance groups | |
| Context | system maintenance group name string | |
| Tree | group | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Name of the maintenance group. | |
| Context | system maintenance group name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
maintenance-mode
| Description | Container with options for activating and deactivating maintenance mode for this group | |
| Context | system maintenance group name string maintenance-mode | |
| Tree | maintenance-mode | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enable or disable maintenance mode for this group The enable setting is blocked if there is another maintenance group with at least one BGP session in its scope that overlaps with this maintenance group and that other maintenance group is currently in maintenance mode. While a maintenance group is in maintenance mode it is not possible to modify the BGP configuration of its members. | |
| Context | system maintenance group name string maintenance-mode admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
maintenance-profile reference
| Description | Leaf reference to /system/maintenance/profile/name | |
| Context | system maintenance group name string maintenance-profile reference | |
| Tree | maintenance-profile | |
| Reference | system maintenance profile name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
members
| Description | Container for specifying the members of the maintenance group - i.e. the components that will eventually be taken out of service for repair or replacement. | |
| Context | system maintenance group name string members | |
| Tree | members | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bgp
| Description | Container for specifying the BGP members of the maintenance group | |
| Context | system maintenance group name string members bgp | |
| Tree | bgp | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance name reference
| Description | List of network instances with one or more peers to be placed in maintenance mode | |
| Context | system maintenance group name string members bgp network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | A unique name identifying the network instance | |
| Context | system maintenance group name string members bgp network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
neighbor reference
| Description | List of BGP neighbors that belong to the network instance and that should be part of the maintenance group It is not necessary to list neighbors that are members of peer-groups that are already listed. If this list is empty and so is the group list, then the system interprets the meaning as ALL static and dynamic sessions belonging to the specified network-instance. | |
| Context | system maintenance group name string members bgp network-instance name reference neighbor reference | |
| Tree | neighbor | |
| Reference | network-instance name string protocols bgp neighbor peer-address (ipv4-address-with-zone | ipv6-address-with-zone) | |
| Configurable | True | |
| Platforms | Supported on all platforms |
peer-group reference
| Description | List of BGP peer groups that belong to the network instance and that should be part of the maintenance group If this list is empty and so is the neighbor list, then the system interprets the meaning as ALL static and dynamic sessions belonging to the specified network-instance. | |
| Context | system maintenance group name string members bgp network-instance name reference peer-group reference | |
| Tree | peer-group | |
| Reference | network-instance name string protocols bgp group group-name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
isis
| Description | Container for specifying the ISIS members of the maintenance group | |
| Context | system maintenance group name string members isis | |
| Tree | isis | |
| Configurable | True | |
| Platforms | isis-maint-mode |
network-instances reference
| Description | List of network instances that should be part of the maintenance group. | |
| Context | system maintenance group name string members isis network-instances reference | |
| Tree | network-instances | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | isis-maint-mode |
profile name string
| Description | Enter the profile list instance | |
| Context | system maintenance profile name string | |
| Tree | profile | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Name of the maintenance profile | |
| Context | system maintenance profile name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bgp
| Description | Container for BGP policies used to achieve traffic draining | |
| Context | system maintenance profile name string bgp | |
| Tree | bgp | |
| Configurable | True | |
| Platforms | Supported on all platforms |
export-policy reference
| Description | A reference to the pre-configured routing policy to apply as an additional/final export policy on BGP sessions in the maintenance group | |
| Context | system maintenance profile name string bgp export-policy reference | |
| Tree | export-policy | |
| Reference | routing-policy policy name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
import-policy reference
| Description | A reference to the pre-configured routing policy to apply as an additional/final import policy on BGP sessions in the maintenance group | |
| Context | system maintenance profile name string bgp import-policy reference | |
| Tree | import-policy | |
| Reference | routing-policy policy name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
isis
| Description | Container for ISIS configurations. | |
| Context | system maintenance profile name string isis | |
| Tree | isis | |
| Configurable | True | |
| Platforms | isis-maint-mode |
overload
| Description | Container for ISIS overload configurations. | |
| Context | system maintenance profile name string isis overload | |
| Tree | overload | |
| Configurable | True | |
| Platforms | isis-maint-mode |
max-metric boolean
| Description | When set to true transit links are advertised with a wide metric of 0xffffffe and a narrow metric of 0x3f | |
| Context | system maintenance profile name string isis overload max-metric boolean | |
| Tree | max-metric | |
| Default | false | |
| Configurable | True | |
| Platforms | isis-maint-mode |
set-bit boolean
management
| Description | Enclosing container for options relating to management server | |
| Context | system management | |
| Tree | management | |
| Configurable | True | |
| Platforms | Supported on all platforms |
openconfig
| Description | Top-level container for options relating to OpenConfig | |
| Context | system management openconfig | |
| Tree | openconfig | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
admin-state keyword
| Description | Enable or disable the OpenConfig management server This will disable OpenConfig throughout the system, and bring any gRPC servers that use it operationally down. | |
| Context | system management openconfig admin-state keyword | |
| Tree | admin-state | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
oper-state keyword
| Description | Indicates the operational state of the OpenConfig management server | |
| Context | system management openconfig oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
mirroring
| Description | Top level container for configuration and operational state for mirroring | |
| Context | system mirroring | |
| Tree | mirroring | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
mirroring-instance name string
| Description | Mirroring instances configured on the local system | |
| Context | system mirroring mirroring-instance name string | |
| Tree | mirroring-instance | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 | |
| Max. Elements | 8 |
name string
| Description | A unique name identifying the mirroring instance | |
| Context | system mirroring mirroring-instance name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
admin-state keyword
| Description | This leaf contains the configured, desired state of the mirroring instance. | |
| Context | system mirroring mirroring-instance name string admin-state keyword | |
| Tree | admin-state | |
| Default | enable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
description string
| Description | A user-entered description of this mirroring instance. | |
| Context | system mirroring mirroring-instance name string description string | |
| Tree | description | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
mirror-destination
| Description | Configure mirror destination | |
| Context | system mirroring mirroring-instance name string mirror-destination | |
| Tree | mirror-destination | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
local string
| Description | subinterface of type local-mirror-dest used as local mirror destination | |
| Context | system mirroring mirroring-instance name string mirror-destination local string | |
| Tree | local | |
| String Length | 5 to 25 | |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
remote
| Description | Enable the remote context | |
| Context | system mirroring mirroring-instance name string mirror-destination remote | |
| Tree | remote | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
encap keyword
| Description | Enter the encap context | |
| Context | system mirroring mirroring-instance name string mirror-destination remote encap keyword | |
| Tree | encap | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
network-instance reference
| Description | network instance to intitiate remote mirror tunnel | |
| Context | system mirroring mirroring-instance name string mirror-destination remote network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
tunnel-end-points
| Description | Enter the tunnel-end-points context | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points | |
| Tree | tunnel-end-points | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
admin-state keyword
| Description | This leaf contains the configured, desired state of the remote mirror tunnel | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points admin-state keyword | |
| Tree | admin-state | |
| Default | enable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
dst-ipv4 string
| Description | remote mirror tunnel destination endpoint IPv4 address | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points dst-ipv4 string | |
| Tree | dst-ipv4 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
dst-ipv6 string
| Description | remote mirror tunnel destination endpoint IPv6 adress | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points dst-ipv6 string | |
| Tree | dst-ipv6 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
oper-state keyword
| Description | This leaf contains the operational state of the remote mirror tunnel | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
src-ipv4 string
| Description | remote mirror tunnel source endpoint IPv4 address | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points src-ipv4 string | |
| Tree | src-ipv4 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
src-ipv6 string
| Description | remote mirror tunnel source endpoint IPv6 address | |
| Context | system mirroring mirroring-instance name string mirror-destination remote tunnel-end-points src-ipv6 string | |
| Tree | src-ipv6 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
mirror-source
| Description | Configure mirror source(s) | |
| Context | system mirroring mirroring-instance name string mirror-source | |
| Tree | mirror-source | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
acl
| Description | Enter the acl context | |
| Context | system mirroring mirroring-instance name string mirror-source acl | |
| Tree | acl | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
ipv4-filter name reference
| Description | Enter the ipv4-filter list instance | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv4-filter name reference | |
| Tree | ipv4-filter | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
name reference
| Description | Enter the name context | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv4-filter name reference | |
| Reference | acl ipv4-filter name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
entry sequence-id reference
| Description | Add a list entry for entry | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv4-filter name reference entry sequence-id reference | |
| Tree | entry | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
sequence-id reference
| Description | Enter the sequence-id context | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv4-filter name reference entry sequence-id reference | |
| Reference | acl ipv4-filter name string entry sequence-id number | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
ipv6-filter name reference
| Description | Enter the ipv6-filter list instance | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv6-filter name reference | |
| Tree | ipv6-filter | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
name reference
| Description | Enter the name context | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv6-filter name reference | |
| Reference | acl ipv6-filter name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
entry sequence-id reference
| Description | Add a list entry for entry | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv6-filter name reference entry sequence-id reference | |
| Tree | entry | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
sequence-id reference
| Description | Enter the sequence-id context | |
| Context | system mirroring mirroring-instance name string mirror-source acl ipv6-filter name reference entry sequence-id reference | |
| Reference | acl ipv6-filter name string entry sequence-id number | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
interface name string
| Description | List of interfaces used as mirror source | |
| Context | system mirroring mirroring-instance name string mirror-source interface name string | |
| Tree | interface | |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
name string
| Description | Enter the name context | |
| Context | system mirroring mirroring-instance name string mirror-source interface name string | |
| String Length | 3 to 20 | |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
direction keyword
| Description | The direction of traffic to be mirrored | |
| Context | system mirroring mirroring-instance name string mirror-source interface name string direction keyword | |
| Tree | direction | |
| Default | egress-only | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
subinterface name string
| Description | List of subinterfaces used as mirror source | |
| Context | system mirroring mirroring-instance name string mirror-source subinterface name string | |
| Tree | subinterface | |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
name string
| Description | Enter the name context | |
| Context | system mirroring mirroring-instance name string mirror-source subinterface name string | |
| String Length | 5 to 25 | |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
direction keyword
| Description | The direction of traffic to be mirrored | |
| Context | system mirroring mirroring-instance name string mirror-source subinterface name string direction keyword | |
| Tree | direction | |
| Default | egress-only | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms except jericho2cp |
oper-down-reason keyword
| Description | The reason for the mirroring instance being operational down | |
| Context | system mirroring mirroring-instance name string oper-down-reason keyword | |
| Tree | oper-down-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
oper-state keyword
| Description | This leaf contains the operational state of the mirroring instance. | |
| Context | system mirroring mirroring-instance name string oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7250 IXR-10e, 7220 IXR-D4, 7220 IXR-D3, 7250 IXR-6e, 7220 IXR-D5 |
mpls
| Description | Container for system wide MPLS label management | |
| Context | system mpls | |
| Tree | mpls | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
label-ranges
| Description | Container for managing MPLS label blocks | |
| Context | system mpls label-ranges | |
| Tree | label-ranges | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
dynamic name string
| Description | List of dynamic label blocks When a client application binds its operation to a dynamic label block that client application is expected to just ask for the next available label within the dynamic label block. At this time a dynamic label block cannot be shared by multiple different clients/protocols. Each protocol needing dynamic labels must have its own label block. | |
| Context | system mpls label-ranges dynamic name string | |
| Tree | dynamic | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
name string
| Description | The name of the dynamic label block | |
| Context | system mpls label-ranges dynamic name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
allocated-labels number
| Description | The number of labels that are currently used in this block | |
| Context | system mpls label-ranges dynamic name string allocated-labels number | |
| Tree | allocated-labels | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
end-label number
| Description | The ending label value of the label block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges dynamic name string end-label number | |
| Tree | end-label | |
| Range | 16 to 1048575 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
free-labels number
| Description | The number of labels that are currently available and free in this block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges dynamic name string free-labels number | |
| Tree | free-labels | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
start-label number
| Description | The starting label value of the label block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges dynamic name string start-label number | |
| Tree | start-label | |
| Range | 16 to 1048575 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
status keyword
| Description | The status of the MPLS label block | |
| Context | system mpls label-ranges dynamic name string status keyword | |
| Tree | status | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
user index number
| Description | The list of protocols that are using this label block. If the block is not shared there will only be 1 user | |
| Context | system mpls label-ranges dynamic name string user index number | |
| Tree | user | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
index number
protocol identityref
| Description | The protocol associated with the client | |
| Context | system mpls label-ranges dynamic name string user index number protocol identityref | |
| Tree | protocol | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
static name string
| Description | List of static label blocks When a client application binds its operation to a static label block that client application is expected to specify the exact label value it wants to use every time it requests a label within the static label block. | |
| Context | system mpls label-ranges static name string | |
| Tree | static | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
name string
| Description | The name of the static label block | |
| Context | system mpls label-ranges static name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
allocated-labels number
| Description | The number of labels that are currently used in this block | |
| Context | system mpls label-ranges static name string allocated-labels number | |
| Tree | allocated-labels | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
end-label number
| Description | The ending label value of the label block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges static name string end-label number | |
| Tree | end-label | |
| Range | 16 to 1048575 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
free-labels number
| Description | The number of labels that are currently available and free in this block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges static name string free-labels number | |
| Tree | free-labels | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
shared boolean
| Description | When set to true, the label block can be shared by multiple protoccols. When set to false, the label block is dedicated to one protocol. | |
| Context | system mpls label-ranges static name string shared boolean | |
| Tree | shared | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
start-label number
| Description | The starting label value of the label block. When the status is not-ready or updating, the state value may be different from the configured value | |
| Context | system mpls label-ranges static name string start-label number | |
| Tree | start-label | |
| Range | 16 to 1048575 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
status keyword
| Description | The status of the MPLS label block | |
| Context | system mpls label-ranges static name string status keyword | |
| Tree | status | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
user index number
| Description | The list of protocols that are using this label block. If the block is not shared there will only be 1 user | |
| Context | system mpls label-ranges static name string user index number | |
| Tree | user | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
index number
protocol identityref
| Description | The protocol associated with the client | |
| Context | system mpls label-ranges static name string user index number protocol identityref | |
| Tree | protocol | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
services
| Description | Container for system wide Services MPLS label management | |
| Context | system mpls services | |
| Tree | services | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
evpn
| Description | Container for system wide Services EVPN MPLS label management | |
| Context | system mpls services evpn | |
| Tree | evpn | |
| Configurable | True | |
| Platforms | evpn-mpls |
dynamic-label-block reference
| Description | Reference to a dynamic label block | |
| Context | system mpls services evpn dynamic-label-block reference | |
| Tree | dynamic-label-block | |
| Reference | system mpls label-ranges dynamic name string | |
| Configurable | True | |
| Platforms | evpn-mpls |
network-instance
| Description | Container for system wide Service Network Instance MPLS label management | |
| Context | system mpls services network-instance | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | network-instance-mpls |
dynamic-label-block reference
| Description | Reference to the dynamic label block used by network-instances The label block is used by all the applications that require MPLS label allocation in a network-instance. For example, EVPN-MPLS services, IP-VPN or Pseudowires. | |
| Context | system mpls services network-instance dynamic-label-block reference | |
| Tree | dynamic-label-block | |
| Reference | system mpls label-ranges dynamic name string | |
| Configurable | True | |
| Platforms | network-instance-mpls |
static-label-block reference
| Description | Reference to the static label block used by network-instances The label block is used by all the applications that require static MPLS label allocation in a network-instance. For example, Pseudowires with static vc labels. | |
| Context | system mpls services network-instance static-label-block reference | |
| Tree | static-label-block | |
| Reference | system mpls label-ranges static name string | |
| Configurable | True | |
| Platforms | network-instance-static-mpls |
mtu
| Description | Top-level container for configuration and state data related to the system MTU | |
| Context | system mtu | |
| Tree | mtu | |
| Configurable | True | |
| Platforms | Supported on all platforms |
default-ip-mtu number
| Description | System default IP MTU in bytes including the IP header but excluding Ethernet overhead The 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-H2, and 7220 IXR-H3 systems support a maximum IP MTU of 9398 bytes. | |
| Context | system mtu default-ip-mtu number | |
| Tree | default-ip-mtu | |
| Range | 1280 to 9486 | |
| Default | 1500 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
default-l2-mtu number
| Description | System default Layer-2 MTU in bytes including ethernet overhead and VLAN tags but excluding 4-bytes FCS The 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-H2, and 7220 IXR-H3 systems support a maximum L2 MTU of 9412 bytes. | |
| Context | system mtu default-l2-mtu number | |
| Tree | default-l2-mtu | |
| Range | 1500 to 9500 | |
| Default | 9232 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
default-mpls-mtu number
| Description | System default MPLS MTU in bytes including the size of the transmitted label stack. | |
| Context | system mtu default-mpls-mtu number | |
| Tree | default-mpls-mtu | |
| Range | 1284 to 9496 | |
| Default | 1508 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
default-port-mtu number
| Description | System default port MTU in bytes including ethernet overhead but excluding 4-bytes FCS The 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-H2, and 7220 IXR-H3 systems support a maximum port MTU of 9412 bytes. | |
| Context | system mtu default-port-mtu number | |
| Tree | default-port-mtu | |
| Range | 1500 to 9500 | |
| Default | 9232 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
min-path-mtu number
| Description | Sets the minimum path MTU to use when receiving an ICMP fragmentation needed message This is controlled via the kernel min_pmtu option. In the event an ICMP fragmentation needed message is received by the kernel, the system will drop the session to this MTU to allow packets to traverse the entire path. | |
| Context | system mtu min-path-mtu number | |
| Tree | min-path-mtu | |
| Range | 552 to 9232 | |
| Default | 552 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
multicast
| Description | system multicast information | |
| Context | system multicast | |
| Tree | multicast | |
| Configurable | True | |
| Platforms | Supported on all platforms |
multicast-ids
| Description | system multicast id information | |
| Context | system multicast multicast-ids | |
| Tree | multicast-ids | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system multicast multicast-ids statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
current-usage number
| Description | The total number of multicast ids that are in use on the system. | |
| Context | system multicast multicast-ids statistics current-usage number | |
| Tree | current-usage | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
maximum-ids number
| Description | Maximum number of multicast ids available in the system. | |
| Context | system multicast multicast-ids statistics maximum-ids number | |
| Tree | maximum-ids | |
| Configurable | False | |
| Platforms | Supported on all platforms |
multicast-id-user-type user keyword
| Description | the type of the user of multicast id in the system. | |
| Context | system multicast multicast-ids statistics multicast-id-user-type user keyword | |
| Tree | multicast-id-user-type | |
| Configurable | False | |
| Platforms | Supported on all platforms |
user keyword
| Description | Enter the user context | |
| Context | system multicast multicast-ids statistics multicast-id-user-type user keyword | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
current-usage number
| Description | The total number of multicast ids that are in use on the system. | |
| Context | system multicast multicast-ids statistics multicast-id-user-type user keyword current-usage number | |
| Tree | current-usage | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-pending number
| Description | The total number of multicast ids pending allocation on the system. | |
| Context | system multicast multicast-ids statistics multicast-id-user-type user keyword total-pending number | |
| Tree | total-pending | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-pending number
| Description | The total number of multicast ids pending allocation on the system. | |
| Context | system multicast multicast-ids statistics total-pending number | |
| Tree | total-pending | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
multicast-forwarding-information-base
| Description | System Multicast Forwarding Information Base table | |
| Context | system multicast-forwarding-information-base | |
| Tree | multicast-forwarding-information-base | |
| Configurable | False | |
| Platforms | Supported on all platforms |
multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address)
| Description | List of all the MFIB entries in the system | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) | |
| Tree | multicast-route | |
| Configurable | False | |
| Platforms | Supported on all platforms |
network-instance reference
| Description | Indicates that the MFIB entry is associated to this network instance | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) | |
| Reference | network-instance name string | |
| Configurable | False | |
| Platforms | Supported on all platforms |
source (ipv4-address | ipv6-address)
| Description | Source IP address of the MFIB entry | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) | |
| Configurable | False | |
| Platforms | Supported on all platforms |
group (ipv4-address | ipv6-address)
| Description | Multicast group address of the MFIB entry | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) | |
| Configurable | False | |
| Platforms | Supported on all platforms |
last-update string
| Description | Last update of this MFIB entry | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) last-update string | |
| Tree | last-update | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
line-card-replication-index number
| Description | Line card Replication Index (LRID) allocated by mfib_mgr Upon programming an MFIB entry, mfib_mgr requests a Multicast Identifier (MCID) to mcid_mgr and based on the response with an allocated MCID, mfib_mgr allocates a LRID for the entry. A value 0 indicates that no MCID was received for the entry, and therefore the MFIB entry cannot forward multicast traffic. | |
| Context | system multicast-forwarding-information-base multicast-route network-instance reference source (ipv4-address | ipv6-address) group (ipv4-address | ipv6-address) line-card-replication-index number | |
| Tree | line-card-replication-index | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
name
| Description | Contains configuration and state related to system naming | |
| Context | system name | |
| Tree | name | |
| Configurable | True | |
| Platforms | Supported on all platforms |
domain-name string
| Description | The system domain name | |
| Context | system name domain-name string | |
| Tree | domain-name | |
| String Length | 1 to 253 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
host-name string
network-instance
| Description | Enable the network-instance context | |
| Context | system network-instance | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
protocols
| Description | The routing protocols that are enabled for this network-instance. | |
| Context | system network-instance protocols | |
| Tree | protocols | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bgp-vpn
| Description | Enable the bgp-vpn context | |
| Context | system network-instance protocols bgp-vpn | |
| Tree | bgp-vpn | |
| Configurable | True | |
| Platforms | Supported on all platforms |
bgp-instance id number
| Description | List of bgp-vpn instances configured in the system network-instance. Only one instance allowed in the current release. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number | |
| Tree | bgp-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 1 |
id number
| Description | The index of the bgp-vpn instance | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number | |
| Range | 1 to 2 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-down-reason keyword
| Description | Reason for the system bgp-instance being down | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number oper-down-reason keyword | |
| Tree | oper-down-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
route-distinguisher
| Description | Route Distinguisher (RD) of the bgp-vpn instance. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-distinguisher | |
| Tree | route-distinguisher | |
| Configurable | True | |
| Platforms | Supported on all platforms |
rd (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
| Description | Route Distinguisher (RD) of the system bgp-vpn instance. The RD is auto-derived as <ip-address>:0 where 'ip-address' is the ipv4 address associated to the subinterface lo0.1. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-distinguisher rd (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b) | |
| Tree | rd | |
| Configurable | False | |
| Platforms | Supported on all platforms |
route-distinguisher-origin keyword
| Description | Origin of the operational Route Distinguisher (RD) of the bgp-vpn instance. 'Auto-derived-from-system-ip:0' refers to the RD for the EVPN Ethernet Segment routes that is automatically allocated with the format <ip-address>:0 where 'ip-address' is the ipv4 address associated to the subinterface lo0.1. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-distinguisher route-distinguisher-origin keyword | |
| Tree | route-distinguisher-origin | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
route-target
| Description | Route Target (RT) of the system bgp-vpn instance. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-target | |
| Tree | route-target | |
| Configurable | True | |
| Platforms | Supported on all platforms |
export-route-target-origin keyword
| Description | Origin of the operational export Route Target (RT) of the bgp-vpn instance. 'Auto-derived-from-esi-bytes-1-6' refers to the ES-import RT for the EVPN Ethernet Segment routes that is derived from bytes 1 to 6 of the Ethernet Segment Identifier of the route. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-target export-route-target-origin keyword | |
| Tree | export-route-target-origin | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
export-rt (string | string | string | string | string | string | string | string | string | string)
| Description | Export Route Target (RT) in the system bgp-vpn instance. When used for evpn ES routes as ES-import Route Target, the RT is auto-derived from the high-order 6-octet portion of the 9-octet ESI value. Note that the ESI value excludes the left-most byte, which is reserved for the ESI type. The RT is encoded into the ES-import extended community advertised along with the ES route. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-target export-rt (string | string | string | string | string | string | string | string | string | string) | |
| Tree | export-rt | |
| Configurable | False | |
| Platforms | Supported on all platforms |
import-route-target-origin keyword
| Description | Origin of the operational import Route Target (RT) of the bgp-vpn instance. 'Auto-derived-from-esi-bytes-1-6' refers to the ES-import RT for the EVPN Ethernet Segment routes that is derived from bytes 1 to 6 of the Ethernet Segment Identifier of the route. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-target import-route-target-origin keyword | |
| Tree | import-route-target-origin | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
import-rt (string | string | string | string | string | string | string | string | string | string)
| Description | Import Route Target (RT) in the system bgp-vpn instance. When used for evpn ES routes as ES-import Route Target, the RT is auto-derived from the high-order 6-octet portion of the 9-octet ESI value. Note that the ESI value excludes the left-most byte, which is reserved for the ESI type. The RT is encoded into the ES-import extended community received along with the ES route. | |
| Context | system network-instance protocols bgp-vpn bgp-instance id number route-target import-rt (string | string | string | string | string | string | string | string | string | string) | |
| Tree | import-rt | |
| Configurable | False | |
| Platforms | Supported on all platforms |
evpn
| Description | Enable the evpn context | |
| Context | system network-instance protocols evpn | |
| Tree | evpn | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ethernet-segments
| Description | Enable the ethernet-segments context | |
| Context | system network-instance protocols evpn ethernet-segments | |
| Tree | ethernet-segments | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
bgp-instance id reference
| Description | bgp global instances configured in net-instance | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference | |
| Tree | bgp-instance | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 | |
| Max. Elements | 1 |
id reference
| Description | Enter the id context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference | |
| Reference | system network-instance protocols bgp-vpn bgp-instance id number | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ethernet-segment name string
| Description | Ethernet Segment configuration and state. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string | |
| Tree | ethernet-segment | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 | |
| Max. Elements | 1024 |
name string
| Description | A unique name identifying the ethernet segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string | |
| String Length | 1 to 32 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
admin-state keyword
| Description | Admin state of the ethernet segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
association
| Description | Enter the association context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association | |
| Tree | association | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
network-instance name string
| Description | network instance associated to this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string | |
| Tree | network-instance | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
name string
| Description | Enter the name context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
bgp-instance instance number
| Description | bgp-instance associated to this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number | |
| Tree | bgp-instance | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
instance number
| Description | Enter the instance context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
computed-designated-forwarder-candidates
| Description | Enter the computed-designated-forwarder-candidates context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number computed-designated-forwarder-candidates | |
| Tree | computed-designated-forwarder-candidates | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
designated-forwarder-candidate address (ipv4-address | ipv6-address)
| Description | designated forwarder candidates for this evi | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number computed-designated-forwarder-candidates designated-forwarder-candidate address (ipv4-address | ipv6-address) | |
| Tree | designated-forwarder-candidate | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
address (ipv4-address | ipv6-address)
| Description | Enter the address context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number computed-designated-forwarder-candidates designated-forwarder-candidate address (ipv4-address | ipv6-address) | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
add-time string
| Description | The date and time when the designated-forwarder-candidate was added to the designated forwarder candidate list for this evi | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number computed-designated-forwarder-candidates designated-forwarder-candidate address (ipv4-address | ipv6-address) add-time string | |
| Tree | add-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
designated-forwarder boolean
| Description | Indicates if this designated-forwarder-candidate is the designated-forwarder. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number computed-designated-forwarder-candidates designated-forwarder-candidate address (ipv4-address | ipv6-address) designated-forwarder boolean | |
| Tree | designated-forwarder | |
| Default | false | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
designated-forwarder-activation-start-time string
| Description | Indicates the time at which the designated-forwarder activation timer started. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number designated-forwarder-activation-start-time string | |
| Tree | designated-forwarder-activation-start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
designated-forwarder-activation-time number
| Description | Indicates the number of seconds for the activation timer to run, for this node to become the designated forwarder for this bgp instance. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number designated-forwarder-activation-time number | |
| Tree | designated-forwarder-activation-time | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
designated-forwarder-role-last-change string
| Description | Indicates the time at which the designated-forwarder role was changed. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string association network-instance name string bgp-instance instance number designated-forwarder-role-last-change string | |
| Tree | designated-forwarder-role-last-change | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
autodiscovery-per-ethernet-segment-routes
| Description | Enter the autodiscovery-per-ethernet-segment-routes context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes | |
| Tree | autodiscovery-per-ethernet-segment-routes | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
attr-id reference
| Description | Leaf reference to networkinstance/protocols/bgp/rib/attr-sets/attr-set/index. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes attr-id reference | |
| Tree | attr-id | |
| Reference | network-instance name string bgp-rib attr-sets attr-set index number | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
esi string
| Description | The Ethernet Segment Identifier encoded in the NLRI | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes esi string | |
| Tree | esi | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ethernet-tag-id number
| Description | The 32-bit Ethernet Tag ID encoded in the NLRI. The Ethernet Tag ID identifies a broadcast domain. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes ethernet-tag-id number | |
| Tree | ethernet-tag-id | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
neighbor (ipv4-address | ipv6-address)
| Description | If the route was learned from a BGP neighbor, this is the IPv4 or IPv6 address of that neighbor. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes neighbor (ipv4-address | ipv6-address) | |
| Tree | neighbor | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
route-distinguisher (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
| Description | The route distinguisher encoded in the NLRI. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes route-distinguisher (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b) | |
| Tree | route-distinguisher | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
vni number
| Description | The VXLAN Netwpork Identifier | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string autodiscovery-per-ethernet-segment-routes vni number | |
| Tree | vni | |
| Range | 0 to 16777215 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
df-election
| Description | Enter the df-election context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election | |
| Tree | df-election | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
algorithm
| Description | Enter the algorithm context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm | |
| Tree | algorithm | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
manual-alg
| Description | Enable the manual-alg context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm manual-alg | |
| Tree | manual-alg | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
primary-evi-range start-evi number
| Description | evi range for this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm manual-alg primary-evi-range start-evi number | |
| Tree | primary-evi-range | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
start-evi number
| Description | start of the evi-range for this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm manual-alg primary-evi-range start-evi number | |
| Range | 1 to 65535 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
end-evi number
| Description | end of the evi-range for this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm manual-alg primary-evi-range start-evi number end-evi number | |
| Tree | end-evi | |
| Range | 1 to 65535 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-type keyword
| Description | Operational Designated Forwarder algorithm type for this ethernet-segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm oper-type keyword | |
| Tree | oper-type | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
preference-alg
| Description | Enable the preference-alg context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg | |
| Tree | preference-alg | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
capabilities
| Description | Enter the capabilities context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg capabilities | |
| Tree | capabilities | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ac-df keyword
| Description | Attachment Circuit influenced DF Election. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg capabilities ac-df keyword | |
| Tree | ac-df | |
| Default | include | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
non-revertive boolean
| Description | Non Revertive mode. If set to true, the 'Don't Preempt Me' capability is advertised in the ES route. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg capabilities non-revertive boolean | |
| Tree | non-revertive | |
| Default | false | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-do-not-prempt boolean
| Description | Operational do-not-preempt value | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg oper-do-not-prempt boolean | |
| Tree | oper-do-not-prempt | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-preference-value number
| Description | Operational Preference value | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg oper-preference-value number | |
| Tree | oper-preference-value | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
preference-value number
| Description | Preference that is used to elect the designated forwarder | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm preference-alg preference-value number | |
| Tree | preference-value | |
| Range | 0 to 65535 | |
| Default | 32767 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
type keyword
| Description | Designated Forwarder algorithm type for this ethernet-segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election algorithm type keyword | |
| Tree | type | |
| Default | default | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
interface-standby-signaling-on-non-df
| Description | Enable the interface-standby-signaling-on-non-df context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election interface-standby-signaling-on-non-df | |
| Tree | interface-standby-signaling-on-non-df | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
timers
| Description | Enter the timers context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election timers | |
| Tree | timers | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
activation-timer number
| Description | Remaining activation timer per Ethernet segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string df-election timers activation-timer number | |
| Tree | activation-timer | |
| Range | 0 to 100 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
esi string
| Description | The 10-byte Ethernet Segment Identifier of the ethernet segment. ESI-0 or MAX-ESI values are not allowed. ESI values with bytes 1-6 all zeros are not allowed since they would produce a null ESI-import route-target. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string esi string | |
| Tree | esi | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ethernet-segment-routes
| Description | Enter the ethernet-segment-routes context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes | |
| Tree | ethernet-segment-routes | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
attr-id reference
| Description | Leaf reference to networkinstance/protocols/bgp/rib/attr-sets/attr-set/index. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes attr-id reference | |
| Tree | attr-id | |
| Reference | network-instance name string bgp-rib attr-sets attr-set index number | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
esi string
| Description | The Ethernet Segment Identifier | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes esi string | |
| Tree | esi | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
neighbor (ipv4-address | ipv6-address)
| Description | If the route was learned from a BGP neighbor, this is the IPv4 or IPv6 address of that neighbor. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes neighbor (ipv4-address | ipv6-address) | |
| Tree | neighbor | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
originating-router (ipv4-address | ipv6-address)
| Description | The IPv4 or IPv6 address of the originating router | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes originating-router (ipv4-address | ipv6-address) | |
| Tree | originating-router | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
route-distinguisher (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b)
| Description | The route distinguisher encoded in the NLRI. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string ethernet-segment-routes route-distinguisher (route-distinguisher-type-0 | route-distinguisher-type-1 | route-distinguisher-type-2 | route-distinguisher-type-2b) | |
| Tree | route-distinguisher | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
interface ethernet-interface reference
| Description | Add a list entry for interface | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string interface ethernet-interface reference | |
| Tree | interface | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 | |
| Max. Elements | 1 |
ethernet-interface reference
| Description | Interface associated with the ethernet segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string interface ethernet-interface reference | |
| Reference | interface name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
multi-homing-mode keyword
| Description | Multi-homing mode of the ethernet segment. The state of this leaf can be different than the configured value in cases where the configured value is 'all-active' and the multi-homing mode advertised by the ES peers in the AD per-ES routes is 'single-active'. In this case, the state of this leaf will show 'single-active'. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string multi-homing-mode keyword | |
| Tree | multi-homing-mode | |
| Default | all-active | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
next-hop l3-next-hop (ipv4-address | ipv6-address)
| Description | Enter the next-hop list instance | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string next-hop l3-next-hop (ipv4-address | ipv6-address) | |
| Tree | next-hop | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 | |
| Max. Elements | 1 |
l3-next-hop (ipv4-address | ipv6-address)
| Description | Layer-3 next-hop associated with the ethernet segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string next-hop l3-next-hop (ipv4-address | ipv6-address) | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
evi start number
| Description | evi range for this ethernet-segment association | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string next-hop l3-next-hop (ipv4-address | ipv6-address) evi start number | |
| Tree | evi | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 | |
| Max. Elements | 1 |
start number
| Description | start of the evi-range for this ethernet-segment | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string next-hop l3-next-hop (ipv4-address | ipv6-address) evi start number | |
| Range | 1 to 65535 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-down-reason keyword
| Description | The reason for the ethernet-segment being down in the bgp-instance | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string oper-down-reason keyword | |
| Tree | oper-down-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-esi string
| Description | The operational Ethernet Segment Identifier used in the ethernet segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string oper-esi string | |
| Tree | oper-esi | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-multi-homing-mode keyword
| Description | Operational Multi-homing mode of the ethernet segment. The state of this leaf can be different than the configured value in cases where the configured value is 'all-active' and the multi-homing mode advertised by the ES peers in the AD per-ES routes is 'single-active'. In this case, the state of this leaf will show 'single-active'. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string oper-multi-homing-mode keyword | |
| Tree | oper-multi-homing-mode | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
oper-state keyword
| Description | This leaf contains the operational state of ethernet segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
routes
| Description | Enter the routes context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string routes | |
| Tree | routes | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ethernet-segment
| Description | Enter the ethernet-segment context | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string routes ethernet-segment | |
| Tree | ethernet-segment | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
originating-ip keyword
| Description | The originating ip-address that the inclusive multicast route will be advertised with in this evpn instance | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string routes ethernet-segment originating-ip keyword | |
| Tree | originating-ip | |
| Default | use-system-ipv4-address | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
next-hop keyword
| Description | The ip-address that will be used as the bgp-next hop for all ES and AD per-ES routes advertised for this Ethernet Segment. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string routes next-hop keyword | |
| Tree | next-hop | |
| Default | use-system-ipv4-address | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
type keyword
| Description | Ethernet Segment type. | |
| Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string type keyword | |
| Tree | type | |
| Default | none | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
timers
| Description | Enter the timers context | |
| Context | system network-instance protocols evpn ethernet-segments timers | |
| Tree | timers | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
activation-timer number
| Description | Enter the activation-timer context | |
| Context | system network-instance protocols evpn ethernet-segments timers activation-timer number | |
| Tree | activation-timer | |
| Range | 0 to 100 | |
| Default | 3 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
boot-remaining-time number
| Description | Indicates the number of seconds remaining for the boot timer to expire. | |
| Context | system network-instance protocols evpn ethernet-segments timers boot-remaining-time number | |
| Tree | boot-remaining-time | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
boot-start-time string
| Description | Indicates the time at which the boot timer started. | |
| Context | system network-instance protocols evpn ethernet-segments timers boot-start-time string | |
| Tree | boot-start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
boot-timer number
| Description | Remaining time before running BGP EVPN multi-homing DF election algorithm | |
| Context | system network-instance protocols evpn ethernet-segments timers boot-timer number | |
| Tree | boot-timer | |
| Range | 0 to 6000 | |
| Default | 10 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D4, 7220 IXR-D3, 7220 IXR-D5 |
ntp
| Description | Top-level container for NTP configuration and state | |
| Context | system ntp | |
| Tree | ntp | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enables the system NTP client and indicates that the system should attempt to synchronize the clock | |
| Context | system ntp admin-state keyword | |
| Tree | admin-state | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance reference
| Description | Reference to a configured network-instance | |
| Context | system ntp network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of the NTP client | |
| Context | system ntp oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
server address (ipv4-address | ipv6-address)
| Description | List of NTP servers to use for system clock synchronization | |
| Context | system ntp server address (ipv4-address | ipv6-address) | |
| Tree | server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
address (ipv4-address | ipv6-address)
iburst boolean
| Description | Indicates whether this server should enable burst synchronization or not iburst, or initial burst, improves the time taken for initial synchronization by sending a burst of eight packets instead of the usual one, these packets are spaced by a two second delay | |
| Context | system ntp server address (ipv4-address | ipv6-address) iburst boolean | |
| Tree | iburst | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
jitter number
offset number
poll-interval number
| Description | Polling interval of the peer | |
| Context | system ntp server address (ipv4-address | ipv6-address) poll-interval number | |
| Tree | poll-interval | |
| Units | seconds | |
| Configurable | False | |
| Platforms | Supported on all platforms |
prefer boolean
| Description | Indicates whether this server should be preferred or not All other things being equal, this host will be chosen for synchronization among a set of correctly operating NTP servers | |
| Context | system ntp server address (ipv4-address | ipv6-address) prefer boolean | |
| Tree | prefer | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
stratum number
| Description | Indicates the level of the server in the NTP hierarchy as number increases, the accuracy is degraded. Primary servers are stratum 1 while a maximum value of 16 indicates unsynchronized. The values have the following meanings: 0 unspecified or invalid 1 primary server (e.g., equipped with a GPS receiver) 2-15 secondary server (via NTP) 16 unsynchronized 17-255 reserved | |
| Context | system ntp server address (ipv4-address | ipv6-address) stratum number | |
| Tree | stratum | |
| Configurable | False | |
| Platforms | Supported on all platforms |
synchronized (ipv4-address | ipv6-address | string)
| Description | Address of the NTP server that the local client is synchronized to This field is set to 'unsynchronized', if the local client is not synchronized | |
| Context | system ntp synchronized (ipv4-address | ipv6-address | string) | |
| Tree | synchronized | |
| Configurable | False | |
| Platforms | Supported on all platforms |
p4rt-server
| Description | Configures the P4Runtime service | |
| Context | system p4rt-server | |
| Tree | p4rt-server | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
admin-state keyword
| Description | Globally enable or disable the P4Runtime service Disabling this will disable all P4Runtime sockets in all configured network-instances (including unix sockets). | |
| Context | system p4rt-server admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
client id number
| Description | List of active P4Runtime client sessions | |
| Context | system p4rt-server client id number | |
| Tree | client | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
id number
| Description | System generated ID for for the client | |
| Context | system p4rt-server client id number | |
| Range | 0 to 4294967295 | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
election-id string
| Description | Election ID of this client | |
| Context | system p4rt-server client id number election-id string | |
| Tree | election-id | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
forwarding-complex
| Description | Enter the forwarding-complex context | |
| Context | system p4rt-server client id number forwarding-complex | |
| Tree | forwarding-complex | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
id number
| Description | The P4Runtime ID of the forwarding complex for which this client has established itself This is the value configured at /platform/linecard/forwarding-complex/p4rt/id, or a system derived default. | |
| Context | system p4rt-server client id number forwarding-complex id number | |
| Tree | id | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
location string
| Description | The normalized location for this forwarding-complex This is the slot number and complex number seperated by a '/', 0 indexed. For example '1/0', or '1/1' representing two forwarding complexes on slot 1. | |
| Context | system p4rt-server client id number forwarding-complex location string | |
| Tree | location | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
primary boolean
remote-host (ipv4-address | ipv6-address)
| Description | Remote host of the client | |
| Context | system p4rt-server client id number remote-host (ipv4-address | ipv6-address) | |
| Tree | remote-host | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
remote-port number
| Description | Remote port of the client | |
| Context | system p4rt-server client id number remote-port number | |
| Tree | remote-port | |
| Range | 0 to 65535 | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
start-time string
| Description | Time the client first connected | |
| Context | system p4rt-server client id number start-time string | |
| Tree | start-time | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
user string
user-agent string
| Description | User agent used for by the client | |
| Context | system p4rt-server client id number user-agent string | |
| Tree | user-agent | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
network-instance name reference
| Description | List of network instances to run a P4Runtime socket in | |
| Context | system p4rt-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
name reference
| Description | Reference to a configured network instance | |
| Context | system p4rt-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
admin-state keyword
| Description | Administratively enable or disable the P4Runtime service | |
| Context | system p4rt-server network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
oper-state keyword
| Description | Details if the P4Runtime service is operationally available | |
| Context | system p4rt-server network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
port number
| Description | TCP port the P4Runtime server will listen on for incoming connections | |
| Context | system p4rt-server network-instance name reference port number | |
| Tree | port | |
| Range | 0 to 65535 | |
| Default | 9559 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses the P4Runtime server will listen on within the network instance By default the P4Runtime server will listen on all addresses in the network-instance. | |
| Context | system p4rt-server network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
tls-profile reference
| Description | Reference to the TLS profile to use on the P4Runtime server | |
| Context | system p4rt-server network-instance name reference tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every P4Runtime RPC request | |
| Context | system p4rt-server network-instance name reference use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
rate-limit number
| Description | Set a limit on the number of connection attempts per minute | |
| Context | system p4rt-server rate-limit number | |
| Tree | rate-limit | |
| Range | 0 to 65535 | |
| Default | 60 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
session-limit number
| Description | Set a limit on the number of simultaneous active P4Runtime sessions A session is defined as an individual RPC invocation, which could result in a single client generating multiple sessions. | |
| Context | system p4rt-server session-limit number | |
| Tree | session-limit | |
| Range | 0 to 65535 | |
| Default | 20 | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
timeout number
| Description | Set the idle timeout in seconds on P4Runtime clients | |
| Context | system p4rt-server timeout number | |
| Tree | timeout | |
| Range | 0 to 65535 | |
| Default | 7200 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
trace-options keyword
| Description | P4Runtime trace options | |
| Context | system p4rt-server trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
unix-socket
| Description | Top-level container for configuration and state related to unix sockets | |
| Context | system p4rt-server unix-socket | |
| Tree | unix-socket | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
admin-state keyword
| Description | Administratively enable or disable the P4Runtime service | |
| Context | system p4rt-server unix-socket admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
oper-state keyword
| Description | Details if the P4Runtime service is operationally available | |
| Context | system p4rt-server unix-socket oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
socket-path string
| Description | Path to the unix socket used by P4Runtime | |
| Context | system p4rt-server unix-socket socket-path string | |
| Tree | socket-path | |
| Configurable | False | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
tls-profile reference
| Description | Reference to the TLS profile to use on the P4Runtime unix socket server If none is specified, then TLS is not used. | |
| Context | system p4rt-server unix-socket tls-profile reference | |
| Tree | tls-profile | |
| Reference | system tls server-profile name string | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
use-authentication boolean
| Description | Enable or disable the use of username/password authentication for every P4Runtime RPC request | |
| Context | system p4rt-server unix-socket use-authentication boolean | |
| Tree | use-authentication | |
| Default | true | |
| Configurable | True | |
| Platforms | 7250 IXR-10e, 7250 IXR-6, 7250 IXR-6e, 7250 IXR-10 |
ra-guard-policy name string
| Description | List containing RA Guard Policy and parameters | |
| Context | system ra-guard-policy name string | |
| Tree | ra-guard-policy | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 | |
| Max. Elements | 64 |
name string
| Description | RA Guard Policy name | |
| Context | system ra-guard-policy name string | |
| String Length | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
action keyword
| Description | Describes the RA Guard Policy action for RA Messages matching the specified attributes. RA Messages no matching the specified attributes will be handled in the opposite manner. | |
| Context | system ra-guard-policy name string action keyword | |
| Tree | action | |
| Default | discard | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
advertise-prefix-set reference
| Description | Reference to a prefix set to match advertised address within RA message | |
| Context | system ra-guard-policy name string advertise-prefix-set reference | |
| Tree | advertise-prefix-set | |
| Reference | routing-policy prefix-set name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
hop-limit number
| Description | Verifies the minimum advertised hop count limit. If not specified the verification is skipped. | |
| Context | system ra-guard-policy name string hop-limit number | |
| Tree | hop-limit | |
| Range | 1 to 255 | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
managed-config-flag boolean
| Description | Causes the RA Guard policy to match IPv6 RA messages with the M (Managed address) flag set. If not specified the verification is skipped. | |
| Context | system ra-guard-policy name string managed-config-flag boolean | |
| Tree | managed-config-flag | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
other-config-flag boolean
| Description | Causes the RA Guard policy to match IPv6 RA messages with the O (Other config) flag set. If not specified the verification is skipped. | |
| Context | system ra-guard-policy name string other-config-flag boolean | |
| Tree | other-config-flag | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
router-preference keyword
| Description | Verifies that the advertised default router preference parameter value is equal to or less than the specified limit. If not specified the verification is skipped. | |
| Context | system ra-guard-policy name string router-preference keyword | |
| Tree | router-preference | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
source-prefix-set reference
| Description | Reference to a prefix set to match RA source address. If not specified the verification is skipped. | |
| Context | system ra-guard-policy name string source-prefix-set reference | |
| Tree | source-prefix-set | |
| Reference | routing-policy prefix-set name string | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D1, 7220 IXR-D3, 7220 IXR-D4, 7220 IXR-D5 |
sflow
| Description | Context to configure sFlow Agent parameters and report sFlow state | |
| Context | system sflow | |
| Tree | sflow | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Administratively enable or disable sFlow for the system | |
| Context | system sflow admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
collector collector-id number
| Description | List of sFlow collectors to which sFlow sample data is sent | |
| Context | system sflow collector collector-id number | |
| Tree | collector | |
| Configurable | True | |
| Platforms | Supported on all platforms | |
| Max. Elements | 8 |
collector-id number
| Description | Specify the collector ID | |
| Context | system sflow collector collector-id number | |
| Range | 1 to 8 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
collector-address (ipv4-address | ipv6-address)
| Description | The IP address for an sFlow collector | |
| Context | system sflow collector collector-id number collector-address (ipv4-address | ipv6-address) | |
| Tree | collector-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
network-instance reference
| Description | Reference to a configured network-instance | |
| Context | system sflow collector collector-id number network-instance reference | |
| Tree | network-instance | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
next-hop (ipv4-address | ipv6-address)
port number
source-address (ipv4-address | ipv6-address)
| Description | Specifies the IP address to be used as the source address in sFlow packets | |
| Context | system sflow collector collector-id number source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
sample-rate number
| Description | Specify sFlow sample rate This value is the rate at which traffic will be sampled at a rate of 1:N received packets. | |
| Context | system sflow sample-rate number | |
| Tree | sample-rate | |
| Range | 1 to 2000000 | |
| Default | 10000 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
sample-size number
| Description | Specify sFlow sample size This value specifies the number of bytes the sFlow agent samples from each frame. | |
| Context | system sflow sample-size number | |
| Tree | sample-size | |
| Range | 256 | |
| Default | 256 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | Specifies the IP address to be used as the source address in sFlow packets | |
| Context | system sflow source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
statistics
| Description | Enter the statistics context | |
| Context | system sflow statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-offered-packets number
| Description | Total number of packets subject to sFlow sampling | |
| Context | system sflow statistics total-offered-packets number | |
| Tree | total-offered-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-samples-taken number
| Description | Total number of sFlow samples taken | |
| Context | system sflow statistics total-samples-taken number | |
| Tree | total-samples-taken | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
total-sent-packets number
| Description | Total number of sFlow packets sent to collectors | |
| Context | system sflow statistics total-sent-packets number | |
| Tree | total-sent-packets | |
| Default | 0 | |
| Configurable | False | |
| Platforms | Supported on all platforms |
snmp
| Description | Top-level container for SNMP configuration and state | |
| Context | system snmp | |
| Tree | snmp | |
| Configurable | True | |
| Platforms | Supported on all platforms |
community string
network-instance name reference
| Description | List of network-instances to run an SNMP server in | |
| Context | system snmp network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network-instance | |
| Context | system snmp network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enables the SNMP server in this network-instance | |
| Context | system snmp network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of the SNMP server | |
| Context | system snmp network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses for the SNMP server to listen on within the network-instance | |
| Context | system snmp network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Default | :: | |
| Configurable | True | |
| Platforms | Supported on all platforms |
ssh-server
| Description | Top-level container for SSH server configuration and state | |
| Context | system ssh-server | |
| Tree | ssh-server | |
| Configurable | True | |
| Platforms | Supported on all platforms |
host-key
| Description | Enter the host-key context | |
| Context | system ssh-server host-key | |
| Tree | host-key | |
| Configurable | True | |
| Platforms | ssh-host-key-preserve |
preserve boolean
| Description | Indicates whether the SSH server host keys should be preserved on reboots Setting this to true will result in host keys in /etc/sshd not being cleared on a reboot. Alternatively setting this to false will result in host keys being removed and regenerated on each reboot of the system. | |
| Context | system ssh-server host-key preserve boolean | |
| Tree | preserve | |
| Default | true | |
| Configurable | True | |
| Platforms | ssh-host-key-preserve |
network-instance name reference
| Description | List of network-instances to run an SSH server in | |
| Context | system ssh-server network-instance name reference | |
| Tree | network-instance | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name reference
| Description | Reference to a configured network-instance | |
| Context | system ssh-server network-instance name reference | |
| Reference | network-instance name string | |
| Configurable | True | |
| Platforms | Supported on all platforms |
admin-state keyword
| Description | Enables the SSH server in this network-instance | |
| Context | system ssh-server network-instance name reference admin-state keyword | |
| Tree | admin-state | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
oper-state keyword
| Description | Details the operational state of the SSH server | |
| Context | system ssh-server network-instance name reference oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | Supported on all platforms |
protocol-version number
| Description | Protocol version in use by the SSH server | |
| Context | system ssh-server network-instance name reference protocol-version number | |
| Tree | protocol-version | |
| Configurable | False | |
| Platforms | Supported on all platforms |
rate-limit number
| Description | Set a limit on the number of unauthenticated sessions to the SSH server after this number is met, the server will start dropping connection attempts | |
| Context | system ssh-server network-instance name reference rate-limit number | |
| Tree | rate-limit | |
| Default | 20 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
source-address (ipv4-address | ipv6-address)
| Description | List of IP addresses for the SSH server to listen on within the network-instance | |
| Context | system ssh-server network-instance name reference source-address (ipv4-address | ipv6-address) | |
| Tree | source-address | |
| Configurable | True | |
| Platforms | Supported on all platforms |
timeout number
| Description | Set the idle timeout in seconds on SSH connections | |
| Context | system ssh-server network-instance name reference timeout number | |
| Tree | timeout | |
| Default | 0 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | Supported on all platforms |
sync
| Description | Context to configure sync parameters and report sessions state | |
| Context | system sync | |
| Tree | sync | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
freq-clock
| Description | Enter the freq-clock context | |
| Context | system sync freq-clock | |
| Tree | freq-clock | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
active-reference keyword
| Description | Displays information about the current selected (active) line timing reference | |
| Context | system sync freq-clock active-reference keyword | |
| Tree | active-reference | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
freq-clock-state keyword
| Description | Shows the frequency clock mode state | |
| Context | system sync freq-clock freq-clock-state keyword | |
| Tree | freq-clock-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
freq-offset decimal-number
| Description | The frequency offset between the central frequency clock and the selected reference in ppb | |
| Context | system sync freq-clock freq-offset decimal-number | |
| Tree | freq-offset | |
| Units | parts-per-billion | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
network-type keyword
| Description | Configures SyncE for SSM code-type as SONET or SDH mode sdh specifies the values corresponding to ITU-T G.781 Option 1 compliant networks. sonet specifies the values corresponding to ITU-T G.781 Option 2 compliant networks. | |
| Context | system sync freq-clock network-type keyword | |
| Tree | network-type | |
| Default | sonet | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ql-input-threshold keyword
| Description | This command configures the minimum acceptable QL value Frequency references with lower QL will not be considered for selection by the system timing module. Options: unused, prs, stu, st2, tnc, st3e, st3, prc, ssua, ssub, sec, eec1, eec2 | |
| Context | system sync freq-clock ql-input-threshold keyword | |
| Tree | ql-input-threshold | |
| Default | unused | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ql-selection boolean
| Description | Configures if frequency reference selection takes the QL (Quality Level) into account When enabled, the selection of system timing reference and BITS output timing reference takes into account quality level. Quality level is conveyed via the SSM or forced using the ql-override command.. | |
| Context | system sync freq-clock ql-selection boolean | |
| Tree | ql-selection | |
| Default | false | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
revert boolean
| Description | This command configures if the frequency clock is in revertive mode In revertive mode, when a failed reference becomes operational, the system will automatically switch to the recovered reference if it is of higher priority and/or QL. When the mode is non-revertive, a failed clock source is not automatically selected. | |
| Context | system sync freq-clock revert boolean | |
| Tree | revert | |
| Default | false | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
system-ql-value keyword
| Description | System QL value based on the reference selected | |
| Context | system sync freq-clock system-ql-value keyword | |
| Tree | system-ql-value | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
wait-to-restore number
| Description | This command configures the time for the Wait to Restore timer A previously failed input reference must be valid for the time specified before it is used for the clock input reference. | |
| Context | system sync freq-clock wait-to-restore number | |
| Tree | wait-to-restore | |
| Range | 0 to 12 | |
| Default | 5 | |
| Units | minutes | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
freq-references
| Description | Enter the freq-references context | |
| Context | system sync freq-references | |
| Tree | freq-references | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
instance instance-number number
| Description | List of line references configured for frequency | |
| Context | system sync freq-references instance instance-number number | |
| Tree | instance | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
instance-number number
| Description | The instance number of the each line reference | |
| Context | system sync freq-references instance instance-number number | |
| Range | 1 to 2 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
admin-state keyword
| Description | Configure the administrative state of this frequency reference instance. | |
| Context | system sync freq-references instance instance-number number admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
not-qualified-reason keyword
| Description | If the reference is not qualified, this identifies the reason | |
| Context | system sync freq-references instance instance-number number not-qualified-reason keyword | |
| Tree | not-qualified-reason | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
oper-state keyword
| Description | Indicates the operational state of this line reference | |
| Context | system sync freq-references instance instance-number number oper-state keyword | |
| Tree | oper-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
priority number
| Description | Sets the priority of this line timing reference for the system timing selection process 1 = highest priority 5 = lowest priority Duplicate numbers are not allowed | |
| Context | system sync freq-references instance instance-number number priority number | |
| Tree | priority | |
| Range | 1 to 5 | |
| Default | 3 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ql-override keyword
| Description | Override the incoming QL/SSM value for this line reference Quality level override of a timing reference Options are unused, prs, stu, st2, tnc, st3e, st3, prc, ssua, ssub, sec, eec1, eec2 | |
| Context | system sync freq-references instance instance-number number ql-override keyword | |
| Tree | ql-override | |
| Default | unused | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ql-value keyword
| Description | The incoming QL/SSM value from this line reference | |
| Context | system sync freq-references instance instance-number number ql-value keyword | |
| Tree | ql-value | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
reference-status keyword
| Description | The current status this line reference | |
| Context | system sync freq-references instance instance-number number reference-status keyword | |
| Tree | reference-status | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
underlying-interface string
| Description | Reference to the configured underlying interface for frequency recovery Options include line/client ports and dedicated syncE/PTP ports, if applicable. | |
| Context | system sync freq-references instance instance-number number underlying-interface string | |
| Tree | underlying-interface | |
| String Length | 3 to 20 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
one-pps
| Description | Enter the one-pps context | |
| Context | system sync one-pps | |
| Tree | one-pps | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
admin-state keyword
| Description | Configure the administrative state of the 1PPS (50 ohm) output port When enabled, output is enabled. Otherwise, the output is disabled. | |
| Context | system sync one-pps admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ptp
| Description | Enter the ptp context | |
| Context | system sync ptp | |
| Tree | ptp | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
instance instance-index number
| Description | List of one or more PTP instances in the product (PTP Node) Each PTP instance represents a distinct instance of PTP implementation (i.e. distinct Ordinary Clock, Boundary Clock, or Transparent Clock), maintaining a distinct time. | |
| Context | system sync ptp instance instance-index number | |
| Tree | instance | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
instance-index number
| Description | The instance index of the current PTP instance This instance index is used for management purposes only. This instance index does not represent the PTP domain number and is not used in PTP messages. | |
| Context | system sync ptp instance instance-index number | |
| Range | 1 to 2 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
current-ds
| Description | Provides current data from operation of the protocol | |
| Context | system sync ptp instance instance-index number current-ds | |
| Tree | current-ds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
mean-delay number
| Description | The mean propagation time between this PTP instance and the master clock | |
| Context | system sync ptp instance instance-index number current-ds mean-delay number | |
| Tree | mean-delay | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
offset-from-master number
| Description | The time difference between this PTP instance and the master clock | |
| Context | system sync ptp instance instance-index number current-ds offset-from-master number | |
| Tree | offset-from-master | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
steps-removed number
| Description | The number of PTP clock steps in the path between the this PTP instance and the GM | |
| Context | system sync ptp instance instance-index number current-ds steps-removed number | |
| Tree | steps-removed | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
default-ds
| Description | The default data set of the PTP instance In the context of the protocol, this data set is required for an Ordinary Clock or Boundary Clock | |
| Context | system sync ptp instance instance-index number default-ds | |
| Tree | default-ds | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
announce-receipt-timeout number
| Description | Sets the time limit for missed Announce packets before the master clock is deemed down This command configures the announceReceiptTimeout value for all peer associations. This defines the number of Announce message intervals that must expire with no received Announce messages before declaring an ANNOUNCE_RECEIPT_TIMEOUT event. | |
| Context | system sync ptp instance instance-index number default-ds announce-receipt-timeout number | |
| Tree | announce-receipt-timeout | |
| Range | 2 to 10 | |
| Default | 3 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
clock-identity binary
| Description | The clockIdentity of the local clock | |
| Context | system sync ptp instance instance-index number default-ds clock-identity binary | |
| Tree | clock-identity | |
| String Length | 8 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-quality
| Description | The clockQuality of the local clock | |
| Context | system sync ptp instance instance-index number default-ds clock-quality | |
| Tree | clock-quality | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-accuracy number
| Description | The clockAccuracy indicates the expected accuracy of the clock | |
| Context | system sync ptp instance instance-index number default-ds clock-quality clock-accuracy number | |
| Tree | clock-accuracy | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-class number
| Description | The clockClass denotes the traceability of the time or frequency distributed by the clock | |
| Context | system sync ptp instance instance-index number default-ds clock-quality clock-class number | |
| Tree | clock-class | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
offset-scaled-log-variance number
| Description | The offsetScaledLogVariance provides an estimate of the variations of the clock | |
| Context | system sync ptp instance instance-index number default-ds clock-quality offset-scaled-log-variance number | |
| Tree | offset-scaled-log-variance | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
current-time
| Description | The current time in the current data set | |
| Context | system sync ptp instance instance-index number default-ds current-time | |
| Tree | current-time | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-nano-seconds number
| Description | Nano-seconds of time | |
| Context | system sync ptp instance instance-index number default-ds current-time time-nano-seconds number | |
| Tree | time-nano-seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-seconds number
| Description | Seconds of time | |
| Context | system sync ptp instance instance-index number default-ds current-time time-seconds number | |
| Tree | time-seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
domain-number number
| Description | The IEEE Std 1588 domainNumber of the PTP instance A domain consists of one or more PTP instances communicating with each other as defined by the protocol. A domain shall define the scope of PTP message communication, state, operations, data sets, and timescale. Therefore, each domain represents a distinct time. | |
| Context | system sync ptp instance instance-index number default-ds domain-number number | |
| Tree | domain-number | |
| Range | 24 to 43 | |
| Default | 24 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
events
| Description | Enter the events context | |
| Context | system sync ptp instance instance-index number default-ds events | |
| Tree | events | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
delay-packet-loss number
| Description | The number of events with detected packet loss for the delay request/response packets | |
| Context | system sync ptp instance instance-index number default-ds events delay-packet-loss number | |
| Tree | delay-packet-loss | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
delay-too-much-pdv-time number
| Description | The number of events with high PDV for delay request/response packets for time recovery | |
| Context | system sync ptp instance instance-index number default-ds events delay-too-much-pdv-time number | |
| Tree | delay-too-much-pdv-time | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-packet-loss number
| Description | The number of events with detected packet loss of sync packets from the master clock | |
| Context | system sync ptp instance instance-index number default-ds events sync-packet-loss number | |
| Tree | sync-packet-loss | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-too-much-pdv-time number
| Description | The number of events with high PDV for sync packets for time recovery | |
| Context | system sync ptp instance instance-index number default-ds events sync-too-much-pdv-time number | |
| Tree | sync-too-much-pdv-time | |
| Default | 0 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
instance-enable boolean
| Description | Enable PTP clock | |
| Context | system sync ptp instance instance-index number default-ds instance-enable boolean | |
| Tree | instance-enable | |
| Default | false | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
instance-type keyword
| Description | The type of PTP instance. oc for T-SC, bc for T-BC | |
| Context | system sync ptp instance instance-index number default-ds instance-type keyword | |
| Tree | instance-type | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
local-priority number
| Description | The IEEE Std 1588 priority2 of the PTP instance The priority2 member is compared by the Best Master Clock Algorithm (BMCA) after priority1 and clockQuality. Lower values take precedence. | |
| Context | system sync ptp instance instance-index number default-ds local-priority number | |
| Tree | local-priority | |
| Range | 1 to 255 | |
| Default | 128 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
log-announce-interval number
| Description | The base-2 logarithm of the mean announceInterval This is themean time interval between successive Announce messages. | |
| Context | system sync ptp instance instance-index number default-ds log-announce-interval number | |
| Tree | log-announce-interval | |
| Range | -3 to 4 | |
| Default | -3 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
number-ports number
| Description | The number of PTP ports on the instance | |
| Context | system sync ptp instance instance-index number default-ds number-ports number | |
| Tree | number-ports | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
priority1 number
| Description | The IEEE Std 1588 priority1 of the PTP instance Since priority1 is one of the first comparisons performed by the Best Master Clock Algorithm (BMCA). Range is 0-255. | |
| Context | system sync ptp instance instance-index number default-ds priority1 number | |
| Tree | priority1 | |
| Range | 0 to 255 | |
| Default | 128 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
priority2 number
| Description | The IEEE Std 1588 priority2 of the PTP instance The priority2 member is compared by the Best Master Clock Algorithm (BMCA) after priority1 and clockQuality. Lower values take precedence. | |
| Context | system sync ptp instance instance-index number default-ds priority2 number | |
| Tree | priority2 | |
| Range | 0 to 255 | |
| Default | 128 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Aggregate statistics for the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-rx number
| Description | Specifies the number of announce messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics anno-msg-rx number | |
| Tree | anno-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-tx number
| Description | Specifies the number of announce messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics anno-msg-tx number | |
| Tree | anno-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-rx number
| Description | Specifies the number of delay-req messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics del-req-msg-rx number | |
| Tree | del-req-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-tx number
| Description | Specifies the number of delay-req messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics del-req-msg-tx number | |
| Tree | del-req-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-rx number
| Description | Specifies the number of delay-resp messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics del-resp-msg-rx number | |
| Tree | del-resp-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-tx number
| Description | Specifies the number of delay-resp messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics del-resp-msg-tx number | |
| Tree | del-resp-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
discards
| Description | Aggregate discard statistics for the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds statistics discards | |
| Tree | discards | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
alternate-master number
| Description | Specifies the number of alternate master messages that were discarded | |
| Context | system sync ptp instance instance-index number default-ds statistics discards alternate-master number | |
| Tree | alternate-master | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
bad-domain number
| Description | Specifies the number of bad domain messages messages that were discarded | |
| Context | system sync ptp instance instance-index number default-ds statistics discards bad-domain number | |
| Tree | bad-domain | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
other number
| Description | Specifies the number of other messages that were discarded | |
| Context | system sync ptp instance instance-index number default-ds statistics discards other number | |
| Tree | other | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
out-of-sequence number
| Description | Specifies the number of out of sequence messages that were discarded | |
| Context | system sync ptp instance instance-index number default-ds statistics discards out-of-sequence number | |
| Tree | out-of-sequence | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-rx number
| Description | Specifies the number of follow-up messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics follow-up-msg-rx number | |
| Tree | follow-up-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-tx number
| Description | Specifies the number of follow-up messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics follow-up-msg-tx number | |
| Tree | follow-up-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
multicast-msg-rate
| Description | Aggregate multicast message rates for the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate | |
| Tree | multicast-msg-rate | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-rate-rx decimal-number
| Description | Specifies the rate of messages of announce messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate anno-msg-rate-rx decimal-number | |
| Tree | anno-msg-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-rate-tx decimal-number
| Description | Specifies the rate of messages of announce messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate anno-msg-rate-tx decimal-number | |
| Tree | anno-msg-rate-tx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-rate-rx decimal-number
| Description | Specifies the rate of messages of delay-req messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate del-req-msg-rate-rx decimal-number | |
| Tree | del-req-msg-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-rate-tx decimal-number
| Description | Specifies the rate of messages of delay-req messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate del-req-msg-rate-tx decimal-number | |
| Tree | del-req-msg-rate-tx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-rate-rx decimal-number
| Description | Specifies the rate of messages of delay-resp messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate del-resp-msg-rate-rx decimal-number | |
| Tree | del-resp-msg-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-rate-tx decimal-number
| Description | Specifies the rate of messages of delay-resp messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate del-resp-msg-rate-tx decimal-number | |
| Tree | del-resp-msg-rate-tx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-rate-rx decimal-number
| Description | Specifies the rate of messages of follow-up messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate follow-up-msg-rate-rx decimal-number | |
| Tree | follow-up-msg-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-rate-tx decimal-number
| Description | Specifies the rate of messages of follow-up messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate follow-up-msg-rate-tx decimal-number | |
| Tree | follow-up-msg-rate-tx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
other-rate-rx decimal-number
| Description | Specifies the rate of messages of other messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate other-rate-rx decimal-number | |
| Tree | other-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-rate-rx decimal-number
| Description | Specifies the rate of messages of sync messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate sync-msg-rate-rx decimal-number | |
| Tree | sync-msg-rate-rx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-rate-tx decimal-number
| Description | Specifies the rate of messages of sync messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics multicast-msg-rate sync-msg-rate-tx decimal-number | |
| Tree | sync-msg-rate-tx | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
other-rx number
| Description | Specifies the number of other messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics other-rx number | |
| Tree | other-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-rx number
| Description | Specifies the number of sync messages received | |
| Context | system sync ptp instance instance-index number default-ds statistics sync-msg-rx number | |
| Tree | sync-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-tx number
| Description | Specifies the number of sync messages transmitted | |
| Context | system sync ptp instance instance-index number default-ds statistics sync-msg-tx number | |
| Tree | sync-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-recovery-engine
| Description | Enter the time-recovery-engine context | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine | |
| Tree | time-recovery-engine | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
algorithm-state keyword
| Description | Specifies the current state of the time recovery engine in the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine algorithm-state keyword | |
| Tree | algorithm-state | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
last-adjustment number
| Description | Specifies the last adjustment in nanoseconds to the local time of the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine last-adjustment number | |
| Tree | last-adjustment | |
| Units | nanoseconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
last-adjustment-timestamp string
| Description | The time when last-adjustment was last calculated | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine last-adjustment-timestamp string | |
| Tree | last-adjustment-timestamp | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
state-last-changed string
| Description | Specifies the last occurance of a ptp state change for the time recovery engine | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine state-last-changed string | |
| Tree | state-last-changed | |
| String Length | 20 to 32 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Time recovery engine state statistics for the PTP clock | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-in-acquiring number
| Description | Specifies the number of seconds while in Acquring state | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics time-in-acquiring number | |
| Tree | time-in-acquiring | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-in-holdover number
| Description | Specifies the number of seconds while in Holdover state | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics time-in-holdover number | |
| Tree | time-in-holdover | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-in-initial number
| Description | Specifies the number of seconds while in Initializatizing state | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics time-in-initial number | |
| Tree | time-in-initial | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-in-locked number
| Description | Specifies the number of seconds while in Locked state | |
| Context | system sync ptp instance instance-index number default-ds time-recovery-engine statistics time-in-locked number | |
| Tree | time-in-locked | |
| Units | seconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
two-step-flag boolean
| Description | When set to true, the clock is a forced into two-step clock Otherwise, the clock operates in one-step mode except when interoperating with a two-step clock. | |
| Context | system sync ptp instance instance-index number default-ds two-step-flag boolean | |
| Tree | two-step-flag | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
parent-ds
| Description | The parent data set of the clock (see IEEE Std 1588-2008 subclause 8.2.3) | |
| Context | system sync ptp instance instance-index number parent-ds | |
| Tree | parent-ds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
grandmaster-clock-quality
| Description | The clockQuality of the grandmaster clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-clock-quality | |
| Tree | grandmaster-clock-quality | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-accuracy number
| Description | The clockAccuracy indicates the expected accuracy of the clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-clock-quality clock-accuracy number | |
| Tree | clock-accuracy | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-class number
| Description | The clockClass denotes the traceability of the time or frequency distributed by the clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-clock-quality clock-class number | |
| Tree | clock-class | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
offset-scaled-log-variance number
| Description | The offsetScaledLogVariance provides an estimate of the variations of the clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-clock-quality offset-scaled-log-variance number | |
| Tree | offset-scaled-log-variance | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
grandmaster-identity binary
| Description | The clockIdentity of the grandmaster clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-identity binary | |
| Tree | grandmaster-identity | |
| String Length | 8 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
grandmaster-priority1 number
| Description | The priority1 attribute of the grandmaster clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-priority1 number | |
| Tree | grandmaster-priority1 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
grandmaster-priority2 number
| Description | The priority2 attribute of the grandmaster clock | |
| Context | system sync ptp instance instance-index number parent-ds grandmaster-priority2 number | |
| Tree | grandmaster-priority2 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
parent-port-identity
| Description | The portIdentity of the port on the master | |
| Context | system sync ptp instance instance-index number parent-ds parent-port-identity | |
| Tree | parent-port-identity | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-identity binary
| Description | Identity of the parent clock | |
| Context | system sync ptp instance instance-index number parent-ds parent-port-identity clock-identity binary | |
| Tree | clock-identity | |
| String Length | 8 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
port-number number
| Description | Port number of the parent clock | |
| Context | system sync ptp instance instance-index number parent-ds parent-port-identity port-number number | |
| Tree | port-number | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
protocol-address
| Description | The protocol address of the PTP Port that issues the Sync messages | |
| Context | system sync ptp instance instance-index number parent-ds protocol-address | |
| Tree | protocol-address | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
mac-address string
| Description | The MAC address of the PTP port This is only valid for PTP over ethernet encapsulation. | |
| Context | system sync ptp instance instance-index number parent-ds protocol-address mac-address string | |
| Tree | mac-address | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
network-protocol identityref
| Description | Protocol used by a PTP instance to transport PTP messages | |
| Context | system sync ptp instance instance-index number parent-ds protocol-address network-protocol identityref | |
| Tree | network-protocol | |
| Default | ieee802-3 | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
port-ds-list port-number number
| Description | List of port data sets of the clock | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number | |
| Tree | port-ds-list | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
port-number number
| Description | Port number The data sets (i.e., information model) of IEEE Std 1588-2008 specify a member portDS.portIdentity, which uses a typed struct with members clockIdentity and portNumber. In this YANG data model, portIdentity is not modeled in the port-ds. However, its members are provided as follows: portIdentity.portNumber is provided as this port-number leaf in port-ds, and portIdentity.clockIdentity is provided as the clock-identity leaf in default-ds of the instance (i.e., ../../default-ds/clock-identity). | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
admin-state keyword
| Description | The administrative state of the ptp port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number admin-state keyword | |
| Tree | admin-state | |
| Default | disable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
announce-receipt-timeout number
| Description | Sets the time limit for missed Announce packets before the master clock is deemed down This command configures the announceReceiptTimeout value for all peer associations. This defines the number of Announce message intervals that must expire with no received Announce messages before declaring an ANNOUNCE_RECEIPT_TIMEOUT event. To change this setting, refer to announce-receipt-timeout in the Default data set. | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number announce-receipt-timeout number | |
| Tree | announce-receipt-timeout | |
| Range | 2 to 10 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
asym-correction number
| Description | Specifies the asymmetry correction value (integer ns) currently used Configuration my be configure under interface>ethernet | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number asym-correction number | |
| Tree | asym-correction | |
| Range | -100000000 to 100000000 | |
| Units | nanoseconds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
best-master boolean
| Description | Indicates if this peer was selected by the BMCA to be the best master | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number best-master boolean | |
| Tree | best-master | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
dest-mac keyword
| Description | Configure the MAC address associated with forwardable or non-forwardable | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number dest-mac keyword | |
| Tree | dest-mac | |
| Default | forwardable | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
dynamic boolean
| Description | Indicates if this port was dynamically created by a Unicast Request TRUE if this port was created based on a received Unicast Request; FALSE if this port was created by operator configuration. | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number dynamic boolean | |
| Tree | dynamic | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
local-priority number
| Description | Specifies the local priority of the ptp port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number local-priority number | |
| Tree | local-priority | |
| Range | 1 to 255 | |
| Default | 128 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
log-announce-interval number
| Description | The base-2 logarithm of the mean announceInterval Mean time interval between successive Announce messages. To change this setting, refer to log-announce-interval in the Default data set. | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number log-announce-interval number | |
| Tree | log-announce-interval | |
| Range | -3 to 4 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
log-min-delay-req-interval number
| Description | The base-2 logarithm of the minDelayReqInterval The minimum permitted mean time interval between successive Delay_Req messages). | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number log-min-delay-req-interval number | |
| Tree | log-min-delay-req-interval | |
| Range | -6 to 0 | |
| Default | -4 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
log-sync-interval number
| Description | The base-2 logarithm of the mean SyncInterval for multicast messages The rates for unicast transmissions are negotiated separately on a per-port basis and are not constrained by this attribute. | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number log-sync-interval number | |
| Tree | log-sync-interval | |
| Range | -6 to 0 | |
| Default | -4 | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
major-version-number number
| Description | The PTP major version number in use on the port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number major-version-number number | |
| Tree | major-version-number | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
master-only boolean
| Description | Specifies the masterOnly attribute of the ptp port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number master-only boolean | |
| Tree | master-only | |
| Default | true | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
minor-version-number number
| Description | The PTP minor version number in use on the port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number minor-version-number number | |
| Tree | minor-version-number | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
neighbor-count number
| Description | The number of neigbors for the port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-count number | |
| Tree | neighbor-count | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
neighbor-list clock-identity binary port-number number
| Description | List of MAC address of all the neighbors of this port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-list clock-identity binary port-number number | |
| Tree | neighbor-list | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
clock-identity binary
| Description | The clockIdentity of this neigbor clock | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-list clock-identity binary port-number number | |
| String Length | 8 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
port-number number
| Description | The port number of this neigbor clock | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-list clock-identity binary port-number number | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
mac-address string
| Description | Specifies the MAC address of this neighbor | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-list clock-identity binary port-number number mac-address string | |
| Tree | mac-address | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
rx-message-rate decimal-number
| Description | The receive message rate from this neigbor clock | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number neighbor-list clock-identity binary port-number number rx-message-rate decimal-number | |
| Tree | rx-message-rate | |
| Units | messages-per-second | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
parent-clock boolean
| Description | Indicates if this peer is the current parent clock of this PTP clock May differ from best-master due to use of local GNSS as time source. | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number parent-clock boolean | |
| Tree | parent-clock | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
port-state keyword
| Description | Current state associated with the port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number port-state keyword | |
| Tree | port-state | |
| Default | initializing | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
statistics
| Description | Total messages for a specific PTP port | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics | |
| Tree | statistics | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-rx number
| Description | Specifies the number of announce messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics anno-msg-rx number | |
| Tree | anno-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
anno-msg-tx number
| Description | Specifies the number of announce messages transmitted | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics anno-msg-tx number | |
| Tree | anno-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-rx number
| Description | Specifies the number of delay-req messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics del-req-msg-rx number | |
| Tree | del-req-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-req-msg-tx number
| Description | Specifies the number of delay-req messages transmitted | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics del-req-msg-tx number | |
| Tree | del-req-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-rx number
| Description | Specifies the number of delay-resp messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics del-resp-msg-rx number | |
| Tree | del-resp-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
del-resp-msg-tx number
| Description | Specifies the number of delay-resp messages transmitted | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics del-resp-msg-tx number | |
| Tree | del-resp-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
discards
| Description | Aggregate discard statistics for the PTP clock | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics discards | |
| Tree | discards | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
alternate-master number
| Description | Specifies the number of alternate master messages that were discarded | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics discards alternate-master number | |
| Tree | alternate-master | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
bad-domain number
| Description | Specifies the number of bad domain messages messages that were discarded | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics discards bad-domain number | |
| Tree | bad-domain | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
other number
| Description | Specifies the number of other messages that were discarded | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics discards other number | |
| Tree | other | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
out-of-sequence number
| Description | Specifies the number of out of sequence messages that were discarded | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics discards out-of-sequence number | |
| Tree | out-of-sequence | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-rx number
| Description | Specifies the number of follow-up messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics follow-up-msg-rx number | |
| Tree | follow-up-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
follow-up-msg-tx number
| Description | Specifies the number of follow-up messages transmitted | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics follow-up-msg-tx number | |
| Tree | follow-up-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
other-rx number
| Description | Specifies the number of other messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics other-rx number | |
| Tree | other-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-rx number
| Description | Specifies the number of sync messages received | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics sync-msg-rx number | |
| Tree | sync-msg-rx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
sync-msg-tx number
| Description | Specifies the number of sync messages transmitted | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number statistics sync-msg-tx number | |
| Tree | sync-msg-tx | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
underlying-transport
| Description | Enter the underlying-transport context | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number underlying-transport | |
| Tree | underlying-transport | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
ethernet-port string
| Description | local interface used for ptp over ethernet communication | |
| Context | system sync ptp instance instance-index number port-ds-list port-number number underlying-transport ethernet-port string | |
| Tree | ethernet-port | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
time-properties-ds
| Description | The timeProperties data set of the clock | |
| Context | system sync ptp instance instance-index number time-properties-ds | |
| Tree | time-properties-ds | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
current-utc-offset number
| Description | The offset between TAI and UTC Only applies when the epoch of the PTP system is the PTP epoch in units of seconds (i.e. when ptp-timescale is TRUE). Otherwise, the value has no meaning. | |
| Context | system sync ptp instance instance-index number time-properties-ds current-utc-offset number | |
| Tree | current-utc-offset | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
current-utc-offset-valid boolean
| Description | When set to true, the current UTC offset is valid | |
| Context | system sync ptp instance instance-index number time-properties-ds current-utc-offset-valid boolean | |
| Tree | current-utc-offset-valid | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
frequency-traceable boolean
| Description | If true, the frequency determining the timescale is traceable to a primary reference | |
| Context | system sync ptp instance instance-index number time-properties-ds frequency-traceable boolean | |
| Tree | frequency-traceable | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
leap59 boolean
| Description | If true, the last minute of the current UTC day contains 59 seconds | |
| Context | system sync ptp instance instance-index number time-properties-ds leap59 boolean | |
| Tree | leap59 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
leap61 boolean
| Description | If true, the last minute of the current UTC day contains 61 seconds | |
| Context | system sync ptp instance instance-index number time-properties-ds leap61 boolean | |
| Tree | leap61 | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
ptp-timescale boolean
| Description | If true, the clock timescale of the grandmaster clock is PTP Otherwise, the timescale is ARB (arbitrary). | |
| Context | system sync ptp instance instance-index number time-properties-ds ptp-timescale boolean | |
| Tree | ptp-timescale | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-source keyword
| Description | The source of time used by the grandmaster clock | |
| Context | system sync ptp instance instance-index number time-properties-ds time-source keyword | |
| Tree | time-source | |
| Options |
| |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
time-traceable boolean
| Description | If true, the timescale and the currentUtcOffset are traceable to a primary reference | |
| Context | system sync ptp instance instance-index number time-properties-ds time-traceable boolean | |
| Tree | time-traceable | |
| Configurable | False | |
| Platforms | 7220 IXR-D5 |
ptp-profile keyword
| Description | Specifies the PTP profile mode for the PTP clock | |
| Context | system sync ptp ptp-profile keyword | |
| Tree | ptp-profile | |
| Default | itug8275dot1 | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
time-clock
| Description | Enter the time-clock context | |
| Context | system sync time-clock | |
| Tree | time-clock | |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
time-reference keyword
| Description | Enter the time-reference context | |
| Context | system sync time-clock time-reference keyword | |
| Tree | time-reference | |
| Default | ptp | |
| Options |
| |
| Configurable | True | |
| Platforms | 7220 IXR-D5 |
tls
| Description | Top-level container for TLS configuration and state | |
| Context | system tls | |
| Tree | tls | |
| Configurable | True | |
| Platforms | Supported on all platforms |
server-profile name string
| Description | List of configured TLS server profiles | |
| Context | system tls server-profile name string | |
| Tree | server-profile | |
| Configurable | True | |
| Platforms | Supported on all platforms |
name string
| Description | Name of the TLS server-profile | |
| Context | system tls server-profile name string | |
| String Length | 1 to 247 | |
| Configurable | True | |
| Platforms | Supported on all platforms |
authenticate-client boolean
| Description | Defines if the server should authenticate the identity of connecting clients using the trust anchor | |
| Context | system tls server-profile name string authenticate-client boolean | |
| Tree | authenticate-client | |
| Default | false | |
| Configurable | True | |
| Platforms | Supported on all platforms |
certificate string
| Description | Base64 encoded certificate to use with the private key this includes the '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' header and footer | |
| Context | system tls server-profile name string certificate string | |
| Tree | certificate | |
| Configurable | True | |
| Platforms | Supported on all platforms |
cipher-list identityref
| Description | List of ciphers to use when negotiating TLS with clients | |
| Context | system tls server-profile name string cipher-list identityref | |
| Tree | cipher-list | |
| Default | ecdhe-rsa-aes128-gcm-sha256 | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
key string
| Description | Base64 encoded key to use with the server certificate This includes the '-----BEGIN PRIVATE KEY-----', and '-----END PRIVATE KEY-----' header and footer The value is hashed, and only the hashed value is kept | |
| Context | system tls server-profile name string key string | |
| Tree | key | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trust-anchor string
| Description | Base64 encoded certificate to use as a trust anchor This includes the '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' header and footer | |
| Context | system tls server-profile name string trust-anchor string | |
| Tree | trust-anchor | |
| Configurable | True | |
| Platforms | Supported on all platforms |
trace-options keyword
| Description | Management server trace options | |
| Context | system trace-options keyword | |
| Tree | trace-options | |
| Options |
| |
| Configurable | True | |
| Platforms | Supported on all platforms |
warm-reboot
| Description | Top-level container for warm reboot options | |
| Context | system warm-reboot | |
| Tree | warm-reboot | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D2L |
bgp-max-wait number
| Description | The maximum amount of time that BGP will wait to receive End of RIB markers from all peers and for all address families that were up prior to warm reboot (in all network instances). After this time elapses BGP declares that convergence has occurred and sends its own EOR markers to its peers. | |
| Context | system warm-reboot bgp-max-wait number | |
| Tree | bgp-max-wait | |
| Range | 0 to 3600 | |
| Default | 600 | |
| Units | seconds | |
| Configurable | True | |
| Platforms | 7220 IXR-D3L, 7220 IXR-D2, 7220 IXR-D3, 7220 IXR-D2L |