system
system
+ aaa
+ accounting
+ accounting-method reference
+ event event-type identityref
+ record identityref
+ authentication
+ admin-user
+ password string
- username string
+ authentication-method reference
+ exit-on-reject boolean
+ idle-timeout number
- session id number
- authentication-method string
- login-time string
- priv-lvl number
- remote-host string
- service-name string
- tty-name string
- username string
+ user username string
+ password string
+ role reference
+ ssh-key string
+ authorization
+ role rolename string
+ tacacs
+ priv-lvl number
+ server-group name string
+ priv-lvl-authorization boolean
+ server address (ipv4-address | ipv6-address)
+ name string
+ network-instance reference
- oper-state keyword
- statistics
- accounting-connection-failures number
- accounting-rejects number
- accounting-success number
- authorization-connection-failures number
- authorization-rejects number
- authorization-success number
- login-connection-failures number
- login-rejects number
- login-success number
+ tacacs
+ port number
+ secret-key string
+ timeout number
+ type identityref
- app-management
- application name string
- author string
- cgroup string
- failure-action string
- failure-threshold number
- failure-window number
- last-change string
- launch-command string
- oom-score-adj number
- path string
- pid number
- restricted-operations keyword
- search-command string
- state keyword
- statistics
- restart-count number
- version string
- yang
- modules string
- source-directories string
+ authentication
+ keychain name string
+ admin-state keyword
+ description string
+ key index number
+ algorithm keyword
+ authentication-key string
+ type keyword
+ banner
+ login-banner string
+ motd-banner string
+ boot
+ autoboot
+ admin-state keyword
+ attempts number
+ client-id keyword
+ interface reference
- oper-state string
+ timeout number
- image string
+ bridge-table
+ mac-learning
- mac-relearn-only boolean
+ mac-limit
- maximum-entries number
- warning-threshold-pct number
- statistics
- active-entries number
- failed-entries number
- mac-type type keyword
- active-entries number
- failed-entries number
- total-entries number
- total-entries number
+ clock
+ timezone keyword
+ configuration
+ auto-checkpoint boolean
- candidate name string
- started string
- type keyword
- username string
- checkpoint id number
- comment string
- created string
- name string
- size number
- tag string
- username string
- version string
- commit id number
- comment string
- ended string
- name string
- started string
- status keyword
- type keyword
- username string
+ idle-timeout number
- last-change string
+ max-candidates number
+ max-checkpoints number
+ role name reference
+ rule path-reference string
+ action keyword
- session id number
- exclusive boolean
- name string
- started string
- type keyword
- username string
+ dhcp-server
+ admin-state keyword
+ network-instance name reference
+ dhcpv4
+ admin-state keyword
- oper-state keyword
+ options
+ bootfile-name string
+ dns-server string
+ domain-name string
+ hostname string
+ ntp-server string
+ router string
+ server-id string
+ static-allocation
+ host mac string
+ ip-address string
+ options
+ bootfile-name string
+ dns-server string
+ domain-name string
+ hostname string
+ ntp-server string
+ router string
+ server-id string
- statistics
- client-packets-discarded number
- client-packets-received number
- server-packets-sent number
+ trace-options
+ trace keyword
+ dhcpv6
+ admin-state keyword
- oper-state keyword
+ options
+ dns-server string
+ static-allocation
+ host mac string
+ ip-address string
+ options
+ dns-server string
- statistics
- client-packets-discarded number
- client-packets-received number
- server-packets-sent number
+ trace-options
+ trace keyword
+ dns
+ host-entry name string
+ ipv4-address string
+ ipv6-address string
+ network-instance reference
- oper-state keyword
+ search-list string
+ server-list (ipv4-address | ipv6-address)
- features string
+ ftp-server
+ network-instance name reference
+ admin-state keyword
- oper-state keyword
+ session-limit number
+ source-address (ipv4-address | ipv6-address)
+ timeout number
+ gnmi-server
+ admin-state keyword
+ commit-confirmed-timeout number
+ commit-save boolean
+ include-defaults-in-config-only-responses boolean
+ network-instance name reference
+ admin-state keyword
- oper-state keyword
+ port number
+ source-address (ipv4-address | ipv6-address)
+ tls-profile reference
+ use-authentication boolean
+ rate-limit number
+ session-limit number
- subscription id number
- mode keyword
- paths string
- remote-host (ipv4-address | ipv6-address)
- remote-port number
- sample-interval number
- start-time string
- user string
- user-agent string
+ timeout number
+ trace-options keyword
+ unix-socket
+ admin-state keyword
- oper-state keyword
- socket-path string
+ tls-profile reference
+ use-authentication boolean
+ information
+ contact string
- current-datetime string
- description string
- last-booted string
+ location string
- version string
+ json-rpc-server
+ admin-state keyword
+ commit-confirmed-timeout number
+ network-instance name reference
+ http
+ admin-state keyword
- oper-state keyword
+ port number
+ session-limit number
+ source-address (ipv4-address | ipv6-address)
+ use-authentication boolean
+ https
+ admin-state keyword
- oper-state keyword
+ port number
+ session-limit number
+ source-address (ipv4-address | ipv6-address)
+ tls-profile reference
+ use-authentication boolean
+ trace-options keyword
+ unix-socket
+ admin-state keyword
- oper-state keyword
- socket-path string
+ tls-profile reference
+ use-authentication boolean
+ lacp
+ system-id string
+ system-priority number
+ lldp
+ admin-state keyword
- chassis-id string
- chassis-id-type keyword
+ hello-timer number
+ hold-multiplier number
+ interface name reference
+ admin-state keyword
- neighbor id string
- capability name string
- enabled boolean
- chassis-id string
- chassis-id-type keyword
- custom-tlv type number oui string oui-subtype string
- value binary
- first-message string
- last-update string
- management-address address string
- type keyword
- port-description string
- port-id (string | binary)
- port-id-type keyword
- system-description string
- system-name string
- oper-state keyword
- statistics
- frame-discard number
- frame-error-in number
- frame-error-out number
- frame-in number
- frame-out number
- last-clear string
- tlv-discard number
- tlv-unknown number
+ management-address subinterface string
+ type keyword
- statistics
- entries-aged-out number
- frame-discard number
- frame-error-in number
- frame-in number
- frame-out number
- last-clear string
- tlv-accepted number
- tlv-discard number
- tlv-unknown number
- system-description string
- system-name string
+ trace-options keyword
+ load-balancing
+ hash-options
+ destination-address boolean
+ destination-port boolean
+ hash-seed number
+ ipv6-flow-label boolean
+ mpls-label-stack boolean
+ protocol boolean
+ source-address boolean
+ source-port boolean
+ vlan boolean
+ logging
+ buffer buffer-name string
+ facility facility-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ filter reference
+ format string
+ persist number
+ rotate number
- rotations number
+ size string
+ subsystem subsystem-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ console
+ facility facility-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ filter reference
+ format string
+ subsystem subsystem-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ file file-name string
+ directory string
+ facility facility-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ filter reference
+ format string
+ rotate number
- rotations number
+ size string
+ subsystem subsystem-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ filter filter-name string
+ contains string
+ facility facility-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ prefix string
+ regex string
+ tag string
+ network-instance reference
+ remote-server host (ipv4-address | ipv6-address | domain-name)
+ facility facility-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ filter reference
+ remote-port number
+ subsystem subsystem-name keyword
+ priority
+ match-above keyword
+ match-exact keyword
+ transport keyword
+ subsystem-facility keyword
+ maintenance
+ group name string
+ maintenance-mode
+ admin-state keyword
+ maintenance-profile reference
+ members
+ bgp
+ network-instance name reference
+ neighbor reference
+ peer-group reference
+ isis
+ network-instances reference
+ profile name string
+ bgp
+ export-policy reference
+ import-policy reference
+ isis
+ overload
+ max-metric boolean
+ set-bit boolean
+ mirroring
+ mirroring-instance name string
+ admin-state keyword
+ description string
+ mirror-destination
+ local string
+ mirror-source
+ interface name string
+ direction keyword
+ subinterface name string
+ direction keyword
- oper-down-reason keyword
- oper-state keyword
+ mtu
+ default-ip-mtu number
+ default-l2-mtu number
+ default-mpls-mtu number
+ default-port-mtu number
+ min-path-mtu number
+ name
+ domain-name string
+ host-name string
+ network-instance
+ protocols
+ bgp-vpn
+ bgp-instance id number
- oper-down-reason keyword
+ route-distinguisher
- rd (string | string | string | string)
- route-distinguisher-origin keyword
+ route-target
- export-route-target-origin keyword
- export-rt (string | string | string | string | string | string | string | string | string | string)
- import-route-target-origin keyword
- import-rt (string | string | string | string | string | string | string | string | string | string)
+ evpn
+ ethernet-segments
+ bgp-instance id reference
+ ethernet-segment name string
+ admin-state keyword
- association
- network-instance name string
- bgp-instance instance number
- computed-designated-forwarder-candidates
- designated-forwarder-candidate address (ipv4-address | ipv6-address)
- add-time string
- designated-forwarder boolean
- designated-forwarder-activation-start-time string
- designated-forwarder-activation-time number
- designated-forwarder-role-last-change string
- autodiscovery-per-ethernet-segment-routes
- attr-id reference
- esi string
- ethernet-tag-id number
- neighbor (ipv4-address | ipv6-address)
- route-distinguisher (string | string | string | string)
- vni number
+ df-election
+ algorithm
- oper-type keyword
+ preference-alg
+ capabilities
+ ac-df keyword
+ non-revertive boolean
- oper-do-not-prempt boolean
- oper-preference-value number
+ preference-value number
+ type keyword
+ interface-standby-signaling-on-non-df
+ timers
+ activation-timer number
+ esi string
- ethernet-segment-routes
- attr-id reference
- esi string
- neighbor (ipv4-address | ipv6-address)
- originating-router (ipv4-address | ipv6-address)
- route-distinguisher (string | string | string | string)
+ interface reference
+ multi-homing-mode keyword
- oper-down-reason keyword
- oper-esi string
- oper-multi-homing-mode keyword
- oper-state keyword
+ routes
+ ethernet-segment
+ originating-ip keyword
+ next-hop keyword
+ timers
+ activation-timer number
- boot-remaining-time number
- boot-start-time string
+ boot-timer number
+ ntp
+ admin-state keyword
+ network-instance reference
- oper-state keyword
+ server address (ipv4-address | ipv6-address)
+ iburst boolean
- jitter string
- offset string
- poll-interval number
+ prefer boolean
- stratum number
- synchronized (ipv4-address | ipv6-address | string)
+ ra-guard-policy name string
+ action keyword
+ advertise-prefix-set reference
+ hop-limit number
+ managed-config-flag boolean
+ other-config-flag boolean
+ router-preference keyword
+ source-prefix-set reference
+ sflow
+ admin-state keyword
+ collector collector-id number
+ collector-address (ipv4-address | ipv6-address)
+ network-instance reference
- next-hop (ipv4-address | ipv6-address)
+ port number
+ source-address (ipv4-address | ipv6-address)
+ sample-rate number
+ sample-size number
- statistics
- total-offered-packets number
- total-samples-taken number
- total-sent-packets number
+ snmp
+ community string
+ network-instance name reference
+ admin-state keyword
- oper-state keyword
+ source-address (ipv4-address | ipv6-address)
+ ssh-server
+ network-instance name reference
+ admin-state keyword
- oper-state keyword
- protocol-version number
+ rate-limit number
+ source-address (ipv4-address | ipv6-address)
+ timeout number
+ tls
+ server-profile name string
+ authenticate-client boolean
+ certificate string
+ cipher-list identityref
+ key string
+ trust-anchor string
+ trace-options keyword
+ warm-reboot
+ bgp-max-wait number
system Descriptions
system
aaa
accounting
Description | Top-level container for accounting | |
Context | system aaa accounting | |
Tree | accounting | |
Configurable | True |
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 |
event event-type identityref
Description | List of events subject to accounting | |
Context | system aaa accounting event event-type identityref | |
Tree | event | |
Configurable | True |
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 |
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 |
authentication
Description | Top-level container for global authentication data | |
Context | system aaa authentication | |
Tree | authentication | |
Configurable | True |
admin-user
Description | Enclosing container for admin user | |
Context | system aaa authentication admin-user | |
Tree | admin-user | |
Configurable | True |
password string
Description | The admin password, supplied as cleartext The system will hash the value, storing only the hashed value | |
Context | system aaa authentication admin-user password string | |
Tree | password | |
Configurable | True |
username string
Description | Assigned username for admin user | |
Context | system aaa authentication admin-user username string | |
Tree | username | |
Default | admin | |
Configurable | False |
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 |
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 |
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 |
session id number
id number
Description | System generated session ID | |
Context | system aaa authentication session id number | |
Configurable | False |
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 |
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 |
priv-lvl number
Note: This command is available for the following platforms:
| ||
Description | TACACS+ authorization priv-lvl (if TACACS+ authorization is enabled) | |
Context | system aaa authentication session id number priv-lvl number | |
Tree | priv-lvl | |
Configurable | False |
remote-host string
Description | Remote host of the session | |
Context | system aaa authentication session id number remote-host string | |
Tree | remote-host | |
Configurable | False |
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 |
tty-name string
username string
user username string
username string
Description | Assigned username for this user | |
Context | system aaa authentication user username string | |
String Length | 1 to 32 | |
Configurable | True |
password string
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 | |
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 | |
Max. Elements | 32 |
authorization
Description | Top-level container for authorization configuration and operational state data | |
Context | system aaa authorization | |
Tree | authorization | |
Configurable | True |
role rolename string
rolename string
Description | Assigned rolename for this role | |
Context | system aaa authorization role rolename string | |
String Length | 1 to 32 | |
Configurable | True |
tacacs
Note: This command is available for the following platforms:
| ||
Description | Top-level container for configuration relating to TACACS+ interworking with roles | |
Context | system aaa authorization role rolename string tacacs | |
Tree | tacacs | |
Configurable | True |
priv-lvl number
Note: This command is available for the following platforms:
| ||
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 |
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 | |
Max. Elements | 2 |
name string
Description | User defined name for the server group | |
Context | system aaa server-group name string | |
String Length | 1 to 255 | |
Configurable | True |
priv-lvl-authorization boolean
Note: This command is available for the following platforms:
| ||
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 |
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 | |
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 | ||
Configurable | True |
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 |
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 |
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 |
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 |
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 |
authorization-connection-failures number
Note: This command is available for the following platforms:
| ||
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 |
authorization-rejects number
Note: This command is available for the following platforms:
| ||
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 |
authorization-success number
Note: This command is available for the following platforms:
| ||
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 |
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 |
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 |
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 |
tacacs
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 |
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 |
app-management
Description | Top-level container for application configuration and state | |
Context | system app-management | |
Tree | app-management | |
Configurable | False |
application name string
Description | List of all applications managed by the application manager | |
Context | system app-management application name string | |
Tree | application | |
Configurable | False |
name string
Description | Unique name of this application instance | |
Context | system app-management application name string | |
Configurable | False |
author string
Description | The author of the application | |
Context | system app-management application name string author string | |
Tree | author | |
Configurable | False |
cgroup string
Description | Cgroup in with this application is started | |
Context | system app-management application name string cgroup string | |
Tree | cgroup | |
Configurable | False |
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 |
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 |
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 |
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 |
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 |
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 |
path string
Description | The directory where the application can be found | |
Context | system app-management application name string path string | |
Tree | path | |
Configurable | False |
pid number
Description | Process ID of this application instance | |
Context | system app-management application name string pid number | |
Tree | pid | |
Configurable | False |
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 |
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 |
state keyword
Description | Current state of this application instance | |
Context | system app-management application name string state keyword | |
Tree | state | |
Options |
| |
Configurable | False |
statistics
Description | Top-level container for application statistics | |
Context | system app-management application name string statistics | |
Tree | statistics | |
Configurable | False |
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 |
version string
Description | The version of the application | |
Context | system app-management application name string version string | |
Tree | version | |
Configurable | False |
yang
Description | Top-level container for application state related to YANG | |
Context | system app-management application name string yang | |
Tree | yang | |
Configurable | False |
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 |
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 |
authentication
Description | Container for protocol authentication options available system wide | |
Context | system authentication | |
Tree | authentication | |
Configurable | True |
keychain name string
Description | List of system keychains | |
Context | system authentication keychain name string | |
Tree | keychain | |
Configurable | True | |
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 |
admin-state keyword
Description | When set to disable, the keychain is inactive. When a protocol refers to a keychain that is inactive, no authentication data is added to the outbound messages and all inbound messages with authentication data are dropped. A key chain is also inactive if no key is configured. | |
Context | system authentication keychain name string admin-state keyword | |
Tree | admin-state | |
Default | disable | |
Options |
| |
Configurable | True |
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 |
key index number
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 |
authentication-key string
Description | The secret key. The maximum string length is 25 characters, of which a maximum of 20 characters is the secret data and the remaining 5 characters, if provided, must be ‘ hash’ (i.e. one whitespace plus the word hash). The trailing ‘hash’ keyword indicates that the secret data was already encrypted and this is the display version of that secret data, which is a hash of the original data. If the ‘hash’ keyword is omitted the string is assumed to be the actual secret data. Whenever the value of authentication-key is read by any management interface, from any datastore (candidate, running, state) the return value is always the encrypted value – i.e. with the trailing ‘ hash’ characters included. | |
Context | system authentication keychain name string key index number authentication-key string | |
Tree | authentication-key | |
String Length | 1 to 25 | |
Configurable | True |
type keyword
Description | Specifies the intended use of the keychain. The type constrains the set of crypto algorithms that are available to use with each key in the keychain. It is also used ensure that this keychain is only used by protocols for which it is intended. | |
Context | system authentication keychain name string type keyword | |
Tree | type | |
Options |
| |
Configurable | True |
banner
login-banner string
Description | Banner to display before a user has authenticated | |
Context | system banner login-banner string | |
Tree | login-banner | |
Configurable | True |
motd-banner string
Description | Banner to display after a user has authenticated | |
Context | system banner motd-banner string | |
Tree | motd-banner | |
Configurable | True |
boot
autoboot
admin-state keyword
Description | Administratively enable or disable autoboot functionality | |
Context | system boot autoboot admin-state keyword | |
Tree | admin-state | |
Options |
| |
Configurable | True |
attempts number
client-id keyword
interface reference
oper-state string
Description | The current operational status of the autoboot process | |
Context | system boot autoboot oper-state string | |
Tree | oper-state | |
Configurable | False |
timeout number
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 | |
Max. Elements | 3 |
bridge-table
Description | system bridge-table information | |
Context | system bridge-table | |
Tree | bridge-table | |
Configurable | True |
mac-learning
Description | Enter the mac-learning context | |
Context | system bridge-table mac-learning | |
Tree | mac-learning | |
Configurable | True |
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 |
mac-limit
Description | Bridge Table size and thresholds. | |
Context | system bridge-table mac-limit | |
Tree | mac-limit | |
Configurable | True |
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 |
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 |
statistics
Description | Enter the statistics context | |
Context | system bridge-table statistics | |
Tree | statistics | |
Configurable | False |
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 |
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 |
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 |
type keyword
Description | Enter the type context | |
Context | system bridge-table statistics mac-type type keyword | |
Options |
| |
Configurable | False |
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 |
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 |
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 |
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 |
clock
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 |
configuration
Description | Top-level container for configuration and state data related to the system configuration | |
Context | system configuration | |
Tree | configuration | |
Configurable | True |
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 |
candidate name string
Description | List of configuration candidates currently active | |
Context | system configuration candidate name string | |
Tree | candidate | |
Configurable | False |
name string
Description | Name of the configuration candidate | |
Context | system configuration candidate name string | |
String Length | 1 to 255 | |
Configurable | False |
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 |
id number
Description | System generated ID for the checkpoint | |
Context | system configuration checkpoint id number | |
Configurable | False |
comment string
Description | User provided annotations associated with the checkpoint | |
Context | system configuration checkpoint id number comment string | |
Tree | comment | |
Configurable | False |
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 |
name string
Description | User provided name of the checkpoint | |
Context | system configuration checkpoint id number name string | |
Tree | name | |
Configurable | False |
size number
Description | Size of the checkpoint configuration file | |
Context | system configuration checkpoint id number size number | |
Tree | size | |
Units | bytes | |
Configurable | False |
tag string
Description | Full system version that the checkpoint was generated on | |
Context | system configuration checkpoint id number tag string | |
Tree | tag | |
Configurable | False |
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 |
version string
Description | System version that the checkpoint was generated on | |
Context | system configuration checkpoint id number version string | |
Tree | version | |
Configurable | False |
commit id number
Description | List of configuration transactions | |
Context | system configuration commit id number | |
Tree | commit | |
Configurable | False |
id number
Description | System identifier for the commit | |
Context | system configuration commit id number | |
Configurable | False |
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 |
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 |
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 |
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 |
role name reference
Description | List of roles configured in the system | |
Context | system configuration role name reference | |
Tree | role | |
Configurable | True | |
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 |
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 | |
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 |
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 |
session id number
Description | List of configuration sessions currently active | |
Context | system configuration session id number | |
Tree | session | |
Configurable | False |
id number
Description | System generated ID for the configuration session | |
Context | system configuration session id number | |
Configurable | False |
exclusive boolean
name string
started string
type keyword
username string
dhcp-server
Note: This command is available for the following platforms:
| ||
Description | Configures the dhcp server | |
Context | system dhcp-server | |
Tree | dhcp-server | |
Configurable | True |
admin-state keyword
Note: This command is available for the following platforms:
| ||
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 |
network-instance name reference
Note: This command is available for the following platforms:
| ||
Description | List of network instances to run a dhcp server in | |
Context | system dhcp-server network-instance name reference | |
Tree | network-instance | |
Configurable | True |
name reference
Note: This command is available for the following platforms:
| ||
Description | Reference to a configured network instance | |
Context | system dhcp-server network-instance name reference | |
Reference | ||
Configurable | True |
dhcpv4
Note: This command is available for the following platforms:
| ||
Description | Enter the dhcpv4 context | |
Context | system dhcp-server network-instance name reference dhcpv4 | |
Tree | dhcpv4 | |
Configurable | True |
admin-state keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-state keyword
Note: This command is available for the following platforms:
| ||
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 |
options
Note: This command is available for the following platforms:
| ||
Description | Enter the options context | |
Context | system dhcp-server network-instance name reference dhcpv4 options | |
Tree | options | |
Configurable | True |
bootfile-name string
Note: This command is available for the following platforms:
| ||
Description | The URL to the provisioning script the client will use during booting | |
Context | system dhcp-server network-instance name reference dhcpv4 options bootfile-name string | |
Tree | bootfile-name | |
String Length | 1 to 128 | |
Configurable | True |
dns-server string
Note: This command is available for the following platforms:
| ||
Description | An Ordered List of DNS servers to return to the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 options dns-server string | |
Tree | dns-server | |
Configurable | True | |
Max. Elements | 4 |
domain-name string
Note: This command is available for the following platforms:
| ||
Description | The domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System | |
Context | system dhcp-server network-instance name reference dhcpv4 options domain-name string | |
Tree | domain-name | |
String Length | 1 to 253 | |
Configurable | True |
hostname string
Note: This command is available for the following platforms:
| ||
Description | Host Name option of the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 options hostname string | |
Tree | hostname | |
String Length | 1 to 63 | |
Configurable | True |
ntp-server string
Note: This command is available for the following platforms:
| ||
Description | List of NTP Servers to return to the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 options ntp-server string | |
Tree | ntp-server | |
Configurable | True | |
Max. Elements | 4 |
router string
Note: This command is available for the following platforms:
| ||
Description | IPv4 address of the gateway for the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 options router string | |
Tree | router | |
Configurable | True |
server-id string
Note: This command is available for the following platforms:
| ||
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 | |
Context | system dhcp-server network-instance name reference dhcpv4 options server-id string | |
Tree | server-id | |
Configurable | True |
static-allocation
Note: This command is available for the following platforms:
| ||
Description | Enter the static-allocation context | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation | |
Tree | static-allocation | |
Configurable | True |
host mac string
Note: This command is available for the following platforms:
| ||
Description | The host name for static ip allocations | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string | |
Tree | host | |
Configurable | True |
mac string
Note: This command is available for the following platforms:
| ||
Description | Enter the mac context | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string | |
Configurable | True |
ip-address string
Note: This command is available for the following platforms:
| ||
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 |
options
Note: This command is available for the following platforms:
| ||
Description | Enter the options context | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options | |
Tree | options | |
Configurable | True |
bootfile-name string
Note: This command is available for the following platforms:
| ||
Description | The URL to the provisioning script the client will use during booting | |
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 |
dns-server string
Note: This command is available for the following platforms:
| ||
Description | An Ordered List of DNS servers to return to the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options dns-server string | |
Tree | dns-server | |
Configurable | True | |
Max. Elements | 4 |
domain-name string
Note: This command is available for the following platforms:
| ||
Description | The domain name to return to the dhcp client that the client should use when resolving hostnames via the Domain Name System | |
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 |
hostname string
Note: This command is available for the following platforms:
| ||
Description | Host Name option of the dhcp client | |
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 |
ntp-server string
Note: This command is available for the following platforms:
| ||
Description | List of NTP Servers to return to the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options ntp-server string | |
Tree | ntp-server | |
Configurable | True | |
Max. Elements | 4 |
router string
Note: This command is available for the following platforms:
| ||
Description | IPv4 address of the gateway for the dhcp client | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options router string | |
Tree | router | |
Configurable | True |
server-id string
Note: This command is available for the following platforms:
| ||
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 | |
Context | system dhcp-server network-instance name reference dhcpv4 static-allocation host mac string options server-id string | |
Tree | server-id | |
Configurable | True |
statistics
Note: This command is available for the following platforms:
| ||
Description | Enter the statistics context | |
Context | system dhcp-server network-instance name reference dhcpv4 statistics | |
Tree | statistics | |
Configurable | False |
client-packets-discarded number
Note: This command is available for the following platforms:
| ||
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 |
client-packets-received number
Note: This command is available for the following platforms:
| ||
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 |
server-packets-sent number
Note: This command is available for the following platforms:
| ||
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 |
trace-options
Note: This command is available for the following platforms:
| ||
Description | Container for tracing DHCP server operations instance | |
Context | system dhcp-server network-instance name reference dhcpv4 trace-options | |
Tree | trace-options | |
Configurable | True |
trace keyword
Note: This command is available for the following platforms:
| ||
Description | List of events to trace | |
Context | system dhcp-server network-instance name reference dhcpv4 trace-options trace keyword | |
Tree | trace | |
Options |
| |
Configurable | True |
dhcpv6
Note: This command is available for the following platforms:
| ||
Description | Enter the dhcpv6 context | |
Context | system dhcp-server network-instance name reference dhcpv6 | |
Tree | dhcpv6 | |
Configurable | True |
admin-state keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-state keyword
Note: This command is available for the following platforms:
| ||
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 |
options
Note: This command is available for the following platforms:
| ||
Description | Enter the options context | |
Context | system dhcp-server network-instance name reference dhcpv6 options | |
Tree | options | |
Configurable | True |
dns-server string
Note: This command is available for the following platforms:
| ||
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 | |
Max. Elements | 4 |
static-allocation
Note: This command is available for the following platforms:
| ||
Description | Enter the static-allocation context | |
Context | system dhcp-server network-instance name reference dhcpv6 static-allocation | |
Tree | static-allocation | |
Configurable | True |
host mac string
Note: This command is available for the following platforms:
| ||
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 |
mac string
Note: This command is available for the following platforms:
| ||
Description | Enter the mac context | |
Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string | |
Configurable | True |
ip-address string
Note: This command is available for the following platforms:
| ||
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 |
options
Note: This command is available for the following platforms:
| ||
Description | Enter the options context | |
Context | system dhcp-server network-instance name reference dhcpv6 static-allocation host mac string options | |
Tree | options | |
Configurable | True |
dns-server string
Note: This command is available for the following platforms:
| ||
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 | |
Max. Elements | 4 |
statistics
Note: This command is available for the following platforms:
| ||
Description | Enter the statistics context | |
Context | system dhcp-server network-instance name reference dhcpv6 statistics | |
Tree | statistics | |
Configurable | False |
client-packets-discarded number
Note: This command is available for the following platforms:
| ||
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 |
client-packets-received number
Note: This command is available for the following platforms:
| ||
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 |
server-packets-sent number
Note: This command is available for the following platforms:
| ||
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 |
trace-options
Note: This command is available for the following platforms:
| ||
Description | Container for tracing DHCP server operations instance | |
Context | system dhcp-server network-instance name reference dhcpv6 trace-options | |
Tree | trace-options | |
Configurable | True |
trace keyword
Note: This command is available for the following platforms:
| ||
Description | List of events to trace | |
Context | system dhcp-server network-instance name reference dhcpv6 trace-options trace keyword | |
Tree | trace | |
Options |
| |
Configurable | True |
dns
host-entry name string
Description | List of static host entries | |
Context | system dns host-entry name string | |
Tree | host-entry | |
Configurable | True |
name string
Description | Name of host entry | |
Context | system dns host-entry name string | |
String Length | 1 to 253 | |
Configurable | True |
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 |
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 |
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 | ||
Configurable | True |
oper-state keyword
Description | Details the operational state of the DNS client | |
Context | system dns oper-state keyword | |
Tree | oper-state | |
Options |
| |
Configurable | False |
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 |
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 | |
Max. Elements | 3 |
features string
ftp-server
Description | Top-level container for FTP server configuration and state | |
Context | system ftp-server | |
Tree | ftp-server | |
Configurable | True |
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 |
name reference
Description | Reference to a configured network-instance | |
Context | system ftp-server network-instance name reference | |
Reference | ||
Configurable | True |
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 |
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 |
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 |
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 |
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 |
gnmi-server
Description | Configures the gNMI server access API | |
Context | system gnmi-server | |
Tree | gnmi-server | |
Configurable | True |
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 |
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 |
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 |
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 |
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 |
name reference
Description | Reference to a configured network instance | |
Context | system gnmi-server network-instance name reference | |
Reference | ||
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
subscription id number
Description | List of subscriptions | |
Context | system gnmi-server subscription id number | |
Tree | subscription | |
Configurable | False |
id number
Description | System generated ID for for the subscription | |
Context | system gnmi-server subscription id number | |
Range | 0 to 4294967295 | |
Configurable | False |
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 |
paths string
Description | List of paths being subscribed to | |
Context | system gnmi-server subscription id number paths string | |
Tree | paths | |
Configurable | False |
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 |
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 |
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 |
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 |
user string
Description | Authenticated username for the subscription | |
Context | system gnmi-server subscription id number user string | |
Tree | user | |
Configurable | False |
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 |
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 |
trace-options keyword
Description | gNMI trace options | |
Context | system gnmi-server trace-options keyword | |
Tree | trace-options | |
Options |
| |
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
information
Description | Top-level container for system information configuration and state | |
Context | system information | |
Tree | information | |
Configurable | True |
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 |
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 |
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 |
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 |
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 |
version string
Description | The system version This field represents the version of the management server | |
Context | system information version string | |
Tree | version | |
Configurable | False |
json-rpc-server
Description | Configures the JSON RPC access API | |
Context | system json-rpc-server | |
Tree | json-rpc-server | |
Configurable | True |
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 |
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 |
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 |
name reference
Description | Reference to a configured network-instance | |
Context | system json-rpc-server network-instance name reference | |
Reference | ||
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
trace-options keyword
Description | JSON RPC trace options | |
Context | system json-rpc-server trace-options keyword | |
Tree | trace-options | |
Options |
| |
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
lacp
system-id string
Note: This command is available for the following platforms:
| ||
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 |
system-priority number
Note: This command is available for the following platforms:
| ||
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 |
lldp
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 |
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 |
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 |
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 |
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 |
interface name reference
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 |
neighbor id string
id string
capability name string
Description | List of LLDP system capabilities advertised by the neighbor | |
Context | system lldp interface name reference neighbor id string capability name string | |
Tree | capability | |
Configurable | False |
name string
Description | Name of the system capability advertised by the neighbor Capabilities are represented in a bitmap that defines the primary functions of the system. The capabilities are defined in IEEE 802.1AB. | |
Context | system lldp interface name reference neighbor id string capability name string | |
Configurable | False |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
statistics
Description | LLDP counters on each interface | |
Context | system lldp interface name reference statistics | |
Tree | statistics | |
Configurable | False |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
statistics
Description | Global LLDP counters | |
Context | system lldp statistics | |
Tree | statistics | |
Configurable | False |
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 |
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 |
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 |
frame-in number
Description | The number of LLDP frames received | |
Context | system lldp statistics frame-in number | |
Tree | frame-in | |
Default | 0 | |
Configurable | False |
frame-out number
Description | The number of LLDP frames transmitted | |
Context | system lldp statistics frame-out number | |
Tree | frame-out | |
Default | 0 | |
Configurable | False |
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 |
tlv-accepted number
Description | The number of valid TLVs received. | |
Context | system lldp statistics tlv-accepted number | |
Tree | tlv-accepted | |
Default | 0 | |
Configurable | False |
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 |
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 |
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 |
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 |
trace-options keyword
Description | LLDP trace options | |
Context | system lldp trace-options keyword | |
Tree | trace-options | |
Options |
| |
Configurable | True |
load-balancing
Description | Adjust system-wide ECMP load balancing options. | |
Context | system load-balancing | |
Tree | load-balancing | |
Configurable | True |
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 |
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 |
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 |
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 |
ipv6-flow-label boolean
Note: This command is available for the following platforms:
| ||
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 |
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 |
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 |
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 |
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 |
vlan boolean
Note: This command is available for the following platforms:
| ||
Description | Include the received VLAN ID in the hash calculation | |
Context | system load-balancing hash-options vlan boolean | |
Tree | vlan | |
Default | true | |
Configurable | True |
logging
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 |
buffer-name string
Description | Base name of the file(s) to be stored in memory | |
Context | system logging buffer buffer-name string | |
Configurable | True |
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 |
facility-name keyword
Description | Name of a Linux syslog facility | |
Context | system logging buffer buffer-name string facility facility-name keyword | |
Options |
| |
Configurable | True |
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 |
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 |
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 |
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 |
format string
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 |
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 |
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 |
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 |
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 |
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 |
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 |
console
facility facility-name keyword
facility-name keyword
Description | Name of a Linux syslog facility | |
Context | system logging console facility facility-name keyword | |
Options |
| |
Configurable | True |
priority
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 |
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 |
filter reference
format string
subsystem subsystem-name keyword
subsystem-name keyword
Description | Reference to an available subsystem to source messages from | |
Context | system logging console subsystem subsystem-name keyword | |
Options |
| |
Configurable | True |
priority
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 |
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 |
file file-name string
file-name string
directory string
facility facility-name keyword
facility-name keyword
priority
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 |
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 |
filter reference
format string
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 |
subsystem subsystem-name keyword
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 |
priority
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 |
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 |
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 |
filter-name string
Description | Name of the filter | |
Context | system logging filter filter-name string | |
Configurable | True |
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 |
facility-name keyword
Description | Name of a Linux syslog facility | |
Context | system logging filter filter-name string facility facility-name keyword | |
Options |
| |
Configurable | True |
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 |
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 |
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 |
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 | ||
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
maintenance
Description | Top-level container for Maintenance Mode configuration | |
Context | system maintenance | |
Tree | maintenance | |
Configurable | True |
group name string
Description | List of user-configured and built-in maintenance groups | |
Context | system maintenance group name string | |
Tree | group | |
Configurable | True |
name string
Description | Name of the maintenance group. The name "system" is reserved | |
Context | system maintenance group name string | |
Configurable | True |
maintenance-mode
Description | Container for activating maintenance mode | |
Context | system maintenance group name string maintenance-mode | |
Tree | maintenance-mode | |
Configurable | True |
admin-state keyword
Description | Enable or disable maintenance mode group | |
Context | system maintenance group name string maintenance-mode admin-state keyword | |
Tree | admin-state | |
Default | disable | |
Options |
| |
Configurable | True |
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 |
members
bgp
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 |
name reference
Description | A unique name identifying the network instance | |
Context | system maintenance group name string members bgp network-instance name reference | |
Reference | ||
Configurable | True |
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 stringname string string protocols bgp neighbor peer-address (ipv4-address | ipv6-address-with-zone) peer-address (ipv4-address | ipv6-address-with-zone) (ipv4-address | ipv6-address-with-zone) | |
Configurable | True |
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 stringname string string protocolsbgp group group-name string group-name string string | |
Configurable | True |
isis
Note: This command is available for the following platforms:
| ||
Description | Container for specifying the ISIS members of the maintenance group | |
Context | system maintenance group name string members isis | |
Tree | isis | |
Configurable | True |
network-instances reference
Note: This command is available for the following platforms:
| ||
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 | ||
Configurable | True |
profile name string
Description | Enter the profile list instance | |
Context | system maintenance profile name string | |
Tree | profile | |
Configurable | True |
name string
Description | Name of the maintenance profile | |
Context | system maintenance profile name string | |
Configurable | True |
bgp
export-policy reference
Description | Enter the export-policy context | |
Context | system maintenance profile name string bgp export-policy reference | |
Tree | export-policy | |
Reference | ||
Configurable | True |
import-policy reference
Description | Enter the import-policy context | |
Context | system maintenance profile name string bgp import-policy reference | |
Tree | import-policy | |
Reference | ||
Configurable | True |
isis
overload
Note: This command is available for the following platforms:
| ||
Description | Container for ISIS overload configurations. | |
Context | system maintenance profile name string isis overload | |
Tree | overload | |
Configurable | True |
max-metric boolean
Note: This command is available for the following platforms:
| ||
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 |
set-bit boolean
Note: This command is available for the following platforms:
| ||
Description | When set to true, the Overload bit is set | |
Context | system maintenance profile name string isis overload set-bit boolean | |
Tree | set-bit | |
Default | false | |
Configurable | True |
mirroring
mirroring-instance name string
Note: This command is available for the following platforms:
| ||
Description | Mirroring instances configured on the local system | |
Context | system mirroring mirroring-instance name string | |
Tree | mirroring-instance | |
Configurable | True | |
Max. Elements | 4 |
name string
Note: This command is available for the following platforms:
| ||
Description | A unique name identifying the mirroring instance | |
Context | system mirroring mirroring-instance name string | |
String Length | 1 to 255 | |
Configurable | True |
admin-state keyword
Note: This command is available for the following platforms:
| ||
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 |
description string
Note: This command is available for the following platforms:
| ||
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 |
mirror-destination
Note: This command is available for the following platforms:
| ||
Description | Configure mirror destination | |
Context | system mirroring mirroring-instance name string mirror-destination | |
Tree | mirror-destination | |
Configurable | True |
local string
Note: This command is available for the following platforms:
| ||
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 |
mirror-source
Note: This command is available for the following platforms:
| ||
Description | Configure mirror source(s) | |
Context | system mirroring mirroring-instance name string mirror-source | |
Tree | mirror-source | |
Configurable | True |
interface name string
Note: This command is available for the following platforms:
| ||
Description | List of interfaces used as mirror source | |
Context | system mirroring mirroring-instance name string mirror-source interface name string | |
Tree | interface | |
Configurable | True | |
Max. Elements | 128 |
name string
Note: This command is available for the following platforms:
| ||
Description | Enter the name context | |
Context | system mirroring mirroring-instance name string mirror-source interface name string | |
String Length | 3 to 20 | |
Configurable | True |
direction keyword
Note: This command is available for the following platforms:
| ||
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 |
subinterface name string
Note: This command is available for the following platforms:
| ||
Description | List of subinterfaces used as mirror source | |
Context | system mirroring mirroring-instance name string mirror-source subinterface name string | |
Tree | subinterface | |
Configurable | True | |
Max. Elements | 128 |
name string
Note: This command is available for the following platforms:
| ||
Description | Enter the name context | |
Context | system mirroring mirroring-instance name string mirror-source subinterface name string | |
String Length | 5 to 25 | |
Configurable | True |
direction keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-down-reason keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-state keyword
Note: This command is available for the following platforms:
| ||
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 |
mtu
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 |
default-l2-mtu number
Note: This command is available for the following platforms:
| ||
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 |
default-mpls-mtu number
Note: This command is available for the following platforms:
| ||
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 |
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 |
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 |
name
domain-name string
Description | The system domain name | |
Context | system name domain-name string | |
Tree | domain-name | |
String Length | 1 to 253 | |
Configurable | True |
host-name string
network-instance
Description | Enable the network-instance context | |
Context | system network-instance | |
Tree | network-instance | |
Configurable | True |
protocols
Description | The routing protocols that are enabled for this network-instance. | |
Context | system network-instance protocols | |
Tree | protocols | |
Configurable | True |
bgp-vpn
Description | Enable the bgp-vpn context | |
Context | system network-instance protocols bgp-vpn | |
Tree | bgp-vpn | |
Configurable | True |
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 | |
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 |
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 |
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 |
rd (string | string | string | string)
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 (string | string | string | string) | |
Tree | rd | |
Configurable | False |
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 |
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 |
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 |
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 |
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 |
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 |
evpn
Note: This command is available for the following platforms:
| ||
Description | Enable the evpn context | |
Context | system network-instance protocols evpn | |
Tree | evpn | |
Configurable | True |
ethernet-segments
Note: This command is available for the following platforms:
| ||
Description | Enable the ethernet-segments context | |
Context | system network-instance protocols evpn ethernet-segments | |
Tree | ethernet-segments | |
Configurable | True |
bgp-instance id reference
Note: This command is available for the following platforms:
| ||
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 | |
Max. Elements | 1 |
id reference
Note: This command is available for the following platforms:
| ||
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 |
ethernet-segment name string
Note: This command is available for the following platforms:
| ||
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 | |
Max. Elements | 128 |
name string
Note: This command is available for the following platforms:
| ||
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 |
admin-state keyword
Note: This command is available for the following platforms:
| ||
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 |
association
Note: This command is available for the following platforms:
| ||
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 |
network-instance name string
Note: This command is available for the following platforms:
| ||
Description | The 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 |
name string
Note: This command is available for the following platforms:
| ||
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 |
bgp-instance instance number
Note: This command is available for the following platforms:
| ||
Description | The 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 |
instance number
Note: This command is available for the following platforms:
| ||
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 |
computed-designated-forwarder-candidates
Note: This command is available for the following platforms:
| ||
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 |
designated-forwarder-candidate address (ipv4-address | ipv6-address)
Note: This command is available for the following platforms:
| ||
Description | The 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 |
address (ipv4-address | ipv6-address)
Note: This command is available for the following platforms:
| ||
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 |
add-time string
Note: This command is available for the following platforms:
| ||
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 |
designated-forwarder boolean
Note: This command is available for the following platforms:
| ||
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 |
designated-forwarder-activation-start-time string
Note: This command is available for the following platforms:
| ||
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 |
designated-forwarder-activation-time number
Note: This command is available for the following platforms:
| ||
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 |
designated-forwarder-role-last-change string
Note: This command is available for the following platforms:
| ||
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 |
autodiscovery-per-ethernet-segment-routes
Note: This command is available for the following platforms:
| ||
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 |
attr-id reference
Note: This command is available for the following platforms:
| ||
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 stringname string string bgp-rib attr-setsattr-set attr-set-type keyword index number attr-set-type keyword keyword index number number | |
Configurable | False |
esi string
Note: This command is available for the following platforms:
| ||
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 |
ethernet-tag-id number
Note: This command is available for the following platforms:
| ||
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 |
neighbor (ipv4-address | ipv6-address)
Note: This command is available for the following platforms:
| ||
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 |
route-distinguisher (string | string | string | string)
Note: This command is available for the following platforms:
| ||
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 (string | string | string | string) | |
Tree | route-distinguisher | |
Configurable | False |
vni number
Note: This command is available for the following platforms:
| ||
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 |
df-election
Note: This command is available for the following platforms:
| ||
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 |
algorithm
Note: This command is available for the following platforms:
| ||
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 |
oper-type keyword
Note: This command is available for the following platforms:
| ||
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 |
preference-alg
Note: This command is available for the following platforms:
| ||
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 |
capabilities
Note: This command is available for the following platforms:
| ||
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 |
ac-df keyword
Note: This command is available for the following platforms:
| ||
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 |
non-revertive boolean
Note: This command is available for the following platforms:
| ||
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 |
oper-do-not-prempt boolean
Note: This command is available for the following platforms:
| ||
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 |
oper-preference-value number
Note: This command is available for the following platforms:
| ||
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 |
preference-value number
Note: This command is available for the following platforms:
| ||
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 |
type keyword
Note: This command is available for the following platforms:
| ||
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 |
interface-standby-signaling-on-non-df
Note: This command is available for the following platforms:
| ||
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 |
timers
Note: This command is available for the following platforms:
| ||
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 |
activation-timer number
Note: This command is available for the following platforms:
| ||
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 |
esi string
Note: This command is available for the following platforms:
| ||
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 |
ethernet-segment-routes
Note: This command is available for the following platforms:
| ||
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 |
attr-id reference
Note: This command is available for the following platforms:
| ||
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 stringname string string bgp-rib attr-setsattr-set attr-set-type keyword index number attr-set-type keyword keyword index number number | |
Configurable | False |
esi string
Note: This command is available for the following platforms:
| ||
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 |
neighbor (ipv4-address | ipv6-address)
Note: This command is available for the following platforms:
| ||
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 |
originating-router (ipv4-address | ipv6-address)
Note: This command is available for the following platforms:
| ||
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 |
route-distinguisher (string | string | string | string)
Note: This command is available for the following platforms:
| ||
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 (string | string | string | string) | |
Tree | route-distinguisher | |
Configurable | False |
interface reference
Note: This command is available for the following platforms:
| ||
Description | Interface associated with the ethernet segment. Only one interface can be associated in the current release. | |
Context | system network-instance protocols evpn ethernet-segments bgp-instance id reference ethernet-segment name string interface reference | |
Tree | interface | |
Reference | interface name string name string string | |
Configurable | True |
multi-homing-mode keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-down-reason keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-esi string
Note: This command is available for the following platforms:
| ||
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 |
oper-multi-homing-mode keyword
Note: This command is available for the following platforms:
| ||
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 |
oper-state keyword
Note: This command is available for the following platforms:
| ||
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 |
routes
Note: This command is available for the following platforms:
| ||
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 |
ethernet-segment
Note: This command is available for the following platforms:
| ||
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 |
originating-ip keyword
Note: This command is available for the following platforms:
| ||
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 |
next-hop keyword
Note: This command is available for the following platforms:
| ||
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 |
timers
Note: This command is available for the following platforms:
| ||
Description | Enter the timers context | |
Context | system network-instance protocols evpn ethernet-segments timers | |
Tree | timers | |
Configurable | True |
activation-timer number
Note: This command is available for the following platforms:
| ||
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 |
boot-remaining-time number
Note: This command is available for the following platforms:
| ||
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 |
boot-start-time string
Note: This command is available for the following platforms:
| ||
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 |
boot-timer number
Note: This command is available for the following platforms:
| ||
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 |
ntp
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 |
network-instance reference
Description | Reference to a configured network-instance | |
Context | system ntp network-instance reference | |
Tree | network-instance | |
Reference | network-instance name string string | |
Configurable | True |
oper-state keyword
Description | Details the operational state of the NTP client | |
Context | system ntp oper-state keyword | |
Tree | oper-state | |
Options |
| |
Configurable | False |
server address (ipv4-address | ipv6-address)
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 |
jitter string
offset string
poll-interval number
Description | Polling interval of the peer | |
Context | system ntp server address (ipv4-address | ipv6-address) poll-interval number | |
Tree | poll-interval | |
Range | 16 to 3600 | |
Units | seconds | |
Configurable | False |
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 |
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 |
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 |
ra-guard-policy name string
Note: This command is available for the following platforms:
| ||
Description | List containing RA Guard Policy and parameters | |
Context | system ra-guard-policy name string | |
Tree | ra-guard-policy | |
Configurable | True | |
Max. Elements | 64 |
name string
Note: This command is available for the following platforms:
| ||
Description | RA Guard Policy name | |
Context | system ra-guard-policy name string | |
String Length | 1 to 255 | |
Configurable | True |
action keyword
Note: This command is available for the following platforms:
| ||
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 |
advertise-prefix-set reference
Note: This command is available for the following platforms:
| ||
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 | ||
Configurable | True |
hop-limit number
Note: This command is available for the following platforms:
| ||
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 |
managed-config-flag boolean
Note: This command is available for the following platforms:
| ||
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 |
other-config-flag boolean
Note: This command is available for the following platforms:
| ||
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 |
router-preference keyword
Note: This command is available for the following platforms:
| ||
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 |
source-prefix-set reference
Note: This command is available for the following platforms:
| ||
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 | ||
Configurable | True |
sflow
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 |
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 | |
Max. Elements | 8 |
collector-id number
Description | Specify the collector ID | |
Context | system sflow collector collector-id number | |
Range | 1 to 8 | |
Configurable | True |
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 |
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 string | |
Configurable | True |
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 |
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 |
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 |
statistics
Description | Enter the statistics context | |
Context | system sflow statistics | |
Tree | statistics | |
Configurable | False |
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 |
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 |
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 |
snmp
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 |
name reference
Description | Reference to a configured network-instance | |
Context | system snmp network-instance name reference | |
Reference |
network-instance name string string | |
Configurable | True |
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 |
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 |
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 |
ssh-server
Description | Top-level container for SSH server configuration and state | |
Context | system ssh-server | |
Tree | ssh-server | |
Configurable | True |
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 |
name reference
Description | Reference to a configured network-instance | |
Context | system ssh-server network-instance name reference | |
Reference |
network-instance name string string | |
Configurable | True |
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 |
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 |
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 |
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 |
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 |
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 |
tls
server-profile name string
Description | List of configured TLS server profiles | |
Context | system tls server-profile name string | |
Tree | server-profile | |
Configurable | True |
name string
Description | Name of the TLS server-profile | |
Context | system tls server-profile name string | |
String Length | 1 to 255 | |
Configurable | True |
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 |
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 |
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 | |
Options |
| |
Configurable | True |
key string
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 |
trace-options keyword
Description | Management server trace options | |
Context | system trace-options keyword | |
Tree | trace-options | |
Options |
| |
Configurable | True |
warm-reboot
Note: This command is available for the following platforms:
| ||
Description | Top-level container for warm reboot options | |
Context | system warm-reboot | |
Tree | warm-reboot | |
Configurable | True |
bgp-max-wait number
Note: This command is available for the following platforms:
| ||
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 |