This module defines types related to the Openflow configuration and operational state model.
openconfig-extensions
description:
Type to define Openflow failure mode.
type: enumeration
description:
Type to define Openflow transport protocol.
type: enumeration
description:
A Controller may have multiple auxiliary connections as
specified by the Openflow protocol. The main Controller
connection should always have the auxiliary-id set to zero.
All other connections must have an auxiliary-id different
from 0.
type: uint8
description:
The datapath-id type represents an OpenFlow
datapath identifier. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined.
type: string
Model for managing system-wide services and functions on network devices.
Portions of this code were derived from IETF RFC 7317. Please reproduce this note if possible.
IETF code is subject to the following copyright and license: Copyright (c) IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).
openconfig-inet-types
openconfig-yang-types
openconfig-types
openconfig-extensions
openconfig-aaa
openconfig-system-logging
openconfig-system-terminal
openconfig-procmon
openconfig-platform
openconfig-alarms
openconfig-messages
openconfig-license
openconfig-network-instance
description:
A time zone name as used by the Time Zone Database,
sometimes referred to as the 'Olson Database'.
The exact set of valid values is an implementation-specific
matter. Client discovery of the exact set of time zone names
for a particular server is out of scope.
type: string
description:
Base identity for encryption schemes supported for NTP
authentication keys
description:
MD5 encryption method
base identity: NTP_AUTH_TYPE
description:
Enclosing container for system-related configuration and
operational state data
nodetype: container (rw)
description:
Global configuration data for the system
nodetype: container (rw)
description:
The hostname of the device -- should be a single domain
label, without the domain.
nodetype: leaf (rw)
type: oc-inet:domain-name
description:
Specifies the domain name used to form fully qualified name
for unqualified hostnames.
nodetype: leaf (rw)
type: oc-inet:domain-name
description:
The console login message displayed before the login prompt,
i.e., before a user logs into the system.
nodetype: leaf (rw)
type: string
description:
The console message displayed after a user logs into the
system. They system may append additional standard
information such as the current system date and time, uptime,
last login timestamp, etc.
nodetype: leaf (rw)
type: string
description:
Global operational state data for the system
nodetype: container (ro)
description:
The hostname of the device -- should be a single domain
label, without the domain.
nodetype: leaf (ro)
type: oc-inet:domain-name
description:
Specifies the domain name used to form fully qualified name
for unqualified hostnames.
nodetype: leaf (ro)
type: oc-inet:domain-name
description:
The console login message displayed before the login prompt,
i.e., before a user logs into the system.
nodetype: leaf (ro)
type: string
description:
The console message displayed after a user logs into the
system. They system may append additional standard
information such as the current system date and time, uptime,
last login timestamp, etc.
nodetype: leaf (ro)
type: string
description:
The current system date and time.
nodetype: leaf (ro)
type: oc-yang:date-and-time
description:
The amount of time since the network operating system was
initialized.
nodetype: leaf (ro)
type: oc-types:timeticks64
units: nanoseconds
description:
This timestamp indicates the time that the system was last
restarted. The value is the timestamp in nanoseconds relative
to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
units: nanoseconds
description:
Operating system version of the currently active controller
of the device. It is required that this value matches the
value of the state/software-version leaf in the component
of type OPERATING_SYSTEM.
nodetype: leaf (ro)
type: string
description:
Indicates the monotonically increasing timestamp at which the
last configuration change was made. This may may be through CLI,
gNMI or some other mechanism. The value is the timestamp in
nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
units: nanoseconds
description:
When a system has a set of filesystems that are attached to a
directory (i.e., mounted on the system) they are expected to be
present in this list. If the system has the concept of mounting
physical or virtual resources to a mount point within the root
filesystem (/) they should also be included in this list.
nodetype: container (ro)
description:
List of mount points in the system.
nodetype: list (ro)
list keys: [name]
description:
Reference to the key for list of mount points.
nodetype: leaf (list key) (ro)
type: leafref
description:
State of system mount point.
nodetype: container (ro)
description:
Mount point name.
nodetype: leaf (ro)
type: string
description:
In the case that the filesystem that is mounted corresponds to a
physical or logical component within the system, this leaf provides
a reference to the hosting component within the /components
hierarchy.
The reference should be to the most specific component (e.g., if an
entry for /dev/sda1 exists, then this should be referred to,
otherwise a reference to /dev/sda may be provided.
nodetype: leaf (ro)
type: leafref
description:
The total size of the initialised filesystem.
nodetype: leaf (ro)
type: uint64
units: megabytes
description:
The amount of unused space on the filesystem.
nodetype: leaf (ro)
type: uint64
units: megabytes
description:
The amount of space currently in use on the filesystem.
nodetype: leaf (ro)
type: uint64
units: megabytes
description:
Top-level container for AAA services
nodetype: container (rw)
description:
Configuration data for top level AAA services
nodetype: container (rw)
description:
Operational state data for top level AAA services
nodetype: container (ro)
description:
Top-level container for global authentication data
nodetype: container (rw)
description:
Configuration data for global authentication services
nodetype: container (rw)
description:
Ordered list of authentication methods for users. This
can be either a reference to a server group, or a well-
defined designation in the AAA_METHOD_TYPE identity. If
authentication fails with one method, the next defined
method is tried -- failure of all methods results in the
user being denied access.
nodetype: leaf-list (rw)
type: union
type: identityref
type: string
description:
Operational state data for global authentication
services
nodetype: container (ro)
description:
Ordered list of authentication methods for users. This
can be either a reference to a server group, or a well-
defined designation in the AAA_METHOD_TYPE identity. If
authentication fails with one method, the next defined
method is tried -- failure of all methods results in the
user being denied access.
nodetype: leaf-list (ro)
type: union
type: identityref
type: string
description:
Top-level container for the system root or admin user
configuration and operational state
nodetype: container (rw)
description:
Configuration data for the root user account
nodetype: container (rw)
description:
The admin/root password, supplied as a cleartext string.
The system should hash and only store the password as a
hashed value.
nodetype: leaf (rw)
type: string
description:
The admin/root password, supplied as a hashed value
using the notation described in the definition of the
crypt-password-type.
nodetype: leaf (rw)
type: oc-aaa-types:crypt-password-type
description:
Operational state data for the root user account
nodetype: container (ro)
description:
The admin/root password, supplied as a cleartext string.
The system should hash and only store the password as a
hashed value.
nodetype: leaf (ro)
type: string
description:
The admin/root password, supplied as a hashed value
using the notation described in the definition of the
crypt-password-type.
nodetype: leaf (ro)
type: oc-aaa-types:crypt-password-type
description:
Name of the administrator user account, e.g., admin, root,
etc.
nodetype: leaf (ro)
type: string
description:
Enclosing container list of local users
nodetype: container (rw)
description:
List of local users on the system
nodetype: list (rw)
list keys: [username]
description:
References the configured username for the user
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for local users
nodetype: container (rw)
description:
Assigned username for this user
nodetype: leaf (rw)
type: string
description:
The user password, supplied as cleartext. The system
must hash the value and only store the hashed value.
nodetype: leaf (rw)
type: string
description:
The user password, supplied as a hashed value
using the notation described in the definition of the
crypt-password-type.
nodetype: leaf (rw)
type: oc-aaa-types:crypt-password-type
description:
SSH public key for the user (RSA or DSA)
nodetype: leaf (rw)
type: string
description:
Role assigned to the user. The role must be supplied
as a role defined by the SYSTEM_DEFINED_ROLES
identity or a string that matches a user defined role.
nodetype: leaf (rw)
type: union
type: string
type: identityref
description:
Operational state data for local users
nodetype: container (ro)
description:
Assigned username for this user
nodetype: leaf (ro)
type: string
description:
The user password, supplied as cleartext. The system
must hash the value and only store the hashed value.
nodetype: leaf (ro)
type: string
description:
The user password, supplied as a hashed value
using the notation described in the definition of the
crypt-password-type.
nodetype: leaf (ro)
type: oc-aaa-types:crypt-password-type
description:
SSH public key for the user (RSA or DSA)
nodetype: leaf (ro)
type: string
description:
Role assigned to the user. The role must be supplied
as a role defined by the SYSTEM_DEFINED_ROLES
identity or a string that matches a user defined role.
nodetype: leaf (ro)
type: union
type: string
type: identityref
description:
Top-level container for AAA authorization configuration
and operational state data
nodetype: container (rw)
description:
Configuration data for authorization based on AAA
methods
nodetype: container (rw)
description:
Ordered list of methods for authorizing commands. The first
method that provides a response (positive or negative) should
be used. The list may contain a well-defined method such
as the set of all TACACS or RADIUS servers, or the name of
a defined AAA server group. The system must validate
that the named server group exists.
nodetype: leaf-list (rw)
type: union
type: identityref
type: string
description:
Operational state data for authorization based on AAA
nodetype: container (ro)
description:
Ordered list of methods for authorizing commands. The first
method that provides a response (positive or negative) should
be used. The list may contain a well-defined method such
as the set of all TACACS or RADIUS servers, or the name of
a defined AAA server group. The system must validate
that the named server group exists.
nodetype: leaf-list (ro)
type: union
type: identityref
type: string
description:
Enclosing container for the set of events subject
to authorization
nodetype: container (rw)
description:
List of events subject to AAA authorization
nodetype: list (rw)
list keys: [event-type]
description:
Reference to the event-type list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each authorized event
nodetype: container (rw)
description:
The type of event to record at the AAA authorization
server
nodetype: leaf (rw)
type: identityref
description:
Operational state data for each authorized activity
nodetype: container (ro)
description:
The type of event to record at the AAA authorization
server
nodetype: leaf (ro)
type: identityref
description:
Top-level container for AAA accounting
nodetype: container (rw)
description:
Configuration data for user activity accounting.
nodetype: container (rw)
description:
An ordered list of methods used for AAA accounting for this
event type. The method is defined by the destination for
accounting data, which may be specified as the group of
all TACACS+/RADIUS servers, a defined server group, or
the local system.
nodetype: leaf-list (rw)
type: union
type: identityref
type: string
description:
Operational state data for user accounting.
nodetype: container (ro)
description:
An ordered list of methods used for AAA accounting for this
event type. The method is defined by the destination for
accounting data, which may be specified as the group of
all TACACS+/RADIUS servers, a defined server group, or
the local system.
nodetype: leaf-list (ro)
type: union
type: identityref
type: string
description:
Enclosing container for defining handling of events
for accounting
nodetype: container (rw)
description:
List of events subject to accounting
nodetype: list (rw)
list keys: [event-type]
description:
Reference to the event-type being logged at the
accounting server
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for accounting events
nodetype: container (rw)
description:
The type of activity to record at the AAA accounting
server
nodetype: leaf (rw)
type: identityref
description:
Type of record to send to the accounting server for this
activity type
nodetype: leaf (rw)
type: enumeration
description:
Operational state data for accounting events
nodetype: container (ro)
description:
The type of activity to record at the AAA accounting
server
nodetype: leaf (ro)
type: identityref
description:
Type of record to send to the accounting server for this
activity type
nodetype: leaf (ro)
type: enumeration
description:
Enclosing container for AAA server groups
nodetype: container (rw)
description:
List of AAA server groups. All servers in a group
must have the same type as indicated by the server
type.
nodetype: list (rw)
list keys: [name]
description:
Reference to configured name of the server group
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each server group
nodetype: container (rw)
description:
Name for the server group
nodetype: leaf (rw)
type: string
description:
AAA server type -- all servers in the group must be of this
type
nodetype: leaf (rw)
type: identityref
description:
Operational state data for each server group
nodetype: container (ro)
description:
Name for the server group
nodetype: leaf (ro)
type: string
description:
AAA server type -- all servers in the group must be of this
type
nodetype: leaf (ro)
type: identityref
description:
Enclosing container the list of servers
nodetype: container (rw)
description:
List of AAA servers
nodetype: list (rw)
list keys: [address]
description:
Reference to the configured address of the AAA server
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data
nodetype: container (rw)
description:
Name assigned to the server
nodetype: leaf (rw)
type: string
description:
Address of the authentication server
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Set the timeout in seconds on responses from the AAA
server
nodetype: leaf (rw)
type: uint16
units: seconds
description:
Operational state data
nodetype: container (ro)
description:
Name assigned to the server
nodetype: leaf (ro)
type: string
description:
Address of the authentication server
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Set the timeout in seconds on responses from the AAA
server
nodetype: leaf (ro)
type: uint16
units: seconds
description:
Number of new connection requests sent to the server, e.g.
socket open
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of connection close requests sent to the server, e.g.
socket close
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of aborted connections to the server. These do
not include connections that are close gracefully.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of connection failures to the server
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of connection timeouts to the server
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of messages sent to the server
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of messages received by the server
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of error messages received from the server
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Top-level container for TACACS+ server data
nodetype: container (rw)
description:
Configuration data for TACACS+ server
nodetype: container (rw)
description:
The port number on which to contact the TACACS server
nodetype: leaf (rw)
type: oc-inet:port-number
default: 49
description:
The unencrypted shared key used between the authentication
server and the device.
nodetype: leaf (rw)
type: oc-types:routing-password
description:
The hashed shared key used between the authentication
server and the device.
nodetype: leaf (rw)
type: oc-aaa-types:crypt-password-type
description:
Source IP address to use in messages to the TACACS server
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Operational state data for TACACS+ server
nodetype: container (ro)
description:
The port number on which to contact the TACACS server
nodetype: leaf (ro)
type: oc-inet:port-number
default: 49
description:
The unencrypted shared key used between the authentication
server and the device.
nodetype: leaf (ro)
type: oc-types:routing-password
description:
The hashed shared key used between the authentication
server and the device.
nodetype: leaf (ro)
type: oc-aaa-types:crypt-password-type
description:
Source IP address to use in messages to the TACACS server
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Top-level container for RADIUS server data
nodetype: container (rw)
description:
Configuration data for RADIUS servers
nodetype: container (rw)
description:
Port number for authentication requests
nodetype: leaf (rw)
type: oc-inet:port-number
default: 1812
description:
Port number for accounting requests
nodetype: leaf (rw)
type: oc-inet:port-number
default: 1813
description:
The unencrypted shared key used between the authentication
server and the device.
nodetype: leaf (rw)
type: oc-types:routing-password
description:
The hashed shared key used between the authentication
server and the device.
nodetype: leaf (rw)
type: oc-aaa-types:crypt-password-type
description:
Source IP address to use in messages to the RADIUS server
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Number of times the system may resend a request to the
RADIUS server when it is unresponsive
nodetype: leaf (rw)
type: uint8
description:
Operational state data for RADIUS servers
nodetype: container (ro)
description:
Port number for authentication requests
nodetype: leaf (ro)
type: oc-inet:port-number
default: 1812
description:
Port number for accounting requests
nodetype: leaf (ro)
type: oc-inet:port-number
default: 1813
description:
The unencrypted shared key used between the authentication
server and the device.
nodetype: leaf (ro)
type: oc-types:routing-password
description:
The hashed shared key used between the authentication
server and the device.
nodetype: leaf (ro)
type: oc-aaa-types:crypt-password-type
description:
Source IP address to use in messages to the RADIUS server
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Number of times the system may resend a request to the
RADIUS server when it is unresponsive
nodetype: leaf (ro)
type: uint8
description:
A collection of RADIUS related state objects.
nodetype: container (ro)
description:
Retransmitted Access-Request messages.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Received Access-Accept messages.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Received Access-Reject messages.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Access-Request messages that have timed-out,
requiring retransmission.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Top-level container for device alarms
nodetype: container (ro)
description:
List of alarms, keyed by a unique id
nodetype: list (ro)
list keys: [id]
description:
References the unique alarm id
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data for each alarm
nodetype: container (ro)
description:
Operational state data for a device alarm
nodetype: container (ro)
description:
Unique ID for the alarm -- this will not be a
configurable parameter on many implementations
nodetype: leaf (ro)
type: string
description:
The item that is under alarm within the device. The
resource may be a reference to an item which is
defined elsewhere in the model. For example, it
may be a platform/component, interfaces/interface,
terminal-device/logical-channels/channel, etc. In this
case the system should match the name of the referenced
item exactly. The referenced item could alternatively be
the path of the item within the model.
nodetype: leaf (ro)
type: string
description:
The string used to inform operators about the alarm. This
MUST contain enough information for an operator to be able
to understand the problem. If this string contains structure,
this format should be clearly documented for programs to be
able to parse that information
nodetype: leaf (ro)
type: string
description:
The time at which the alarm was raised by the system.
This value is expressed relative to the Unix Epoch.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The severity level indicating the criticality and impact
of the alarm
nodetype: leaf (ro)
type: identityref
description:
The abbreviated name of the alarm, for example LOS,
EQPT, or OTS. Also referred to in different systems as
condition type, alarm identifier, or alarm mnemonic. It
is recommended to use the OPENCONFIG_ALARM_TYPE_ID
identities where possible and only use the string type
when the desired identityref is not yet defined
nodetype: leaf (ro)
type: union
type: string
type: identityref
description:
Top-level container for data related to logging / syslog
nodetype: container (rw)
description:
Top-level container for data related to console-based
logging
nodetype: container (rw)
description:
Configuration data for console logging
nodetype: container (rw)
description:
Operational state data for console logging
nodetype: container (ro)
description:
Enclosing container
nodetype: container (rw)
description:
List of selectors for log messages
nodetype: list (rw)
list keys: [facility] [severity]
description:
Reference to facility list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to severity list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data
nodetype: container (rw)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (rw)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (rw)
type: syslog-severity
description:
Operational state data
nodetype: container (ro)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (ro)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (ro)
type: syslog-severity
description:
Enclosing container for the list of remote log
servers
nodetype: container (rw)
description:
List of remote log servers
nodetype: list (rw)
list keys: [host]
description:
Reference to the host list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for remote log servers
nodetype: container (rw)
description:
IP address or hostname of the remote log server
nodetype: leaf (rw)
type: oc-inet:host
description:
Source IP address for packets to the log server
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
The network instance used to reach the log server. If no
instance is specified, DEFAULT_INSTANCE is used.
nodetype: leaf (rw)
type: oc-ni:network-instance-ref
description:
Sets the destination port number for syslog UDP messages to
the server. The default for syslog is 514.
nodetype: leaf (rw)
type: oc-inet:port-number
default: 514
description:
Operational state data for remote log servers
nodetype: container (ro)
description:
IP address or hostname of the remote log server
nodetype: leaf (ro)
type: oc-inet:host
description:
Source IP address for packets to the log server
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
The network instance used to reach the log server. If no
instance is specified, DEFAULT_INSTANCE is used.
nodetype: leaf (ro)
type: oc-ni:network-instance-ref
description:
Sets the destination port number for syslog UDP messages to
the server. The default for syslog is 514.
nodetype: leaf (ro)
type: oc-inet:port-number
default: 514
description:
Enclosing container
nodetype: container (rw)
description:
List of selectors for log messages
nodetype: list (rw)
list keys: [facility] [severity]
description:
Reference to facility list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to severity list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data
nodetype: container (rw)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (rw)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (rw)
type: syslog-severity
description:
Operational state data
nodetype: container (ro)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (ro)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (ro)
type: syslog-severity
description:
Enclosing container for the list of log files
nodetype: container (rw)
description:
List of logfiles
nodetype: list (rw)
list keys: [path] [filename-prefix]
description:
Reference to the logfiles list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to the logfiles list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for logfile
nodetype: container (rw)
description:
A name used for the file. It is expected that an
implementation may append timestamp, serial-number or
other identifier to the filename.
nodetype: leaf (rw)
type: string
description:
The fully specified path of the folder where the
logfile is stored. The path is implementation specific
and may include attributes such as a drive identifier.
nodetype: leaf (rw)
type: string
description:
Used for logfile rotation.
Log files are rotated the number of times defined by
this leaf.
The default value of 1 indicates that there will be one
rotation file and one active file. A 0 value indicates
old versions are removed rather than rotated.
nodetype: leaf (rw)
type: uint32
default: 0
description:
Used for logfile rotation.
Maximum size in Bytes, logfile may grow to. When logfile
reach this size it triggers log rotation. The log file need to
be save, closed, and new file open or future log storage.
If needed oldest logfile of same prefix shall be deleted to
nodetype: leaf (rw)
type: uint32
default: 1000
description:
Used for logfile rotation.
Maximum time, in minutes, the logfile can be open. When expires,
it triggers log rotation.
Actions are same ans when log file reaches its max-size.
it need to be closed, save, and new file open or future log
storage. If needed oldest logfile of same prefix shall be
deleted to
nodetype: leaf (rw)
type: uint32
default: 1440
description:
Operational state data for logfile servers
nodetype: container (ro)
description:
A name used for the file. It is expected that an
implementation may append timestamp, serial-number or
other identifier to the filename.
nodetype: leaf (ro)
type: string
description:
The fully specified path of the folder where the
logfile is stored. The path is implementation specific
and may include attributes such as a drive identifier.
nodetype: leaf (ro)
type: string
description:
Used for logfile rotation.
Log files are rotated the number of times defined by
this leaf.
The default value of 1 indicates that there will be one
rotation file and one active file. A 0 value indicates
old versions are removed rather than rotated.
nodetype: leaf (ro)
type: uint32
default: 0
description:
Used for logfile rotation.
Maximum size in Bytes, logfile may grow to. When logfile
reach this size it triggers log rotation. The log file need to
be save, closed, and new file open or future log storage.
If needed oldest logfile of same prefix shall be deleted to
nodetype: leaf (ro)
type: uint32
default: 1000
description:
Used for logfile rotation.
Maximum time, in minutes, the logfile can be open. When expires,
it triggers log rotation.
Actions are same ans when log file reaches its max-size.
it need to be closed, save, and new file open or future log
storage. If needed oldest logfile of same prefix shall be
deleted to
nodetype: leaf (ro)
type: uint32
default: 1440
description:
the currently active/open filename prepended by folder path
and including suffix appended to filename-prefix by system
nodetype: leaf (ro)
type: string
description:
Enclosing container
nodetype: container (rw)
description:
List of selectors for log messages
nodetype: list (rw)
list keys: [facility] [severity]
description:
Reference to facility list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to severity list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data
nodetype: container (rw)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (rw)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (rw)
type: syslog-severity
description:
Operational state data
nodetype: container (ro)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (ro)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (ro)
type: syslog-severity
description:
Top-level container for data related to vty-based
logging (active sessions of ssh, telnet, etc )
nodetype: container (rw)
description:
Configuration data for vty logging
nodetype: container (rw)
description:
Operational state data for console logging
nodetype: container (ro)
description:
Enclosing container
nodetype: container (rw)
description:
List of selectors for log messages
nodetype: list (rw)
list keys: [facility] [severity]
description:
Reference to facility list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Reference to severity list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data
nodetype: container (rw)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (rw)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (rw)
type: syslog-severity
description:
Operational state data
nodetype: container (ro)
description:
Specifies the facility, or class of messages to log
nodetype: leaf (ro)
type: identityref
description:
Specifies that only messages of the given severity (or
greater severity) for the corresonding facility are logged
nodetype: leaf (ro)
type: syslog-severity
description:
Parameters related to all monitored processes
nodetype: container (rw)
description:
List of monitored processes
nodetype: list (ro)
list keys: [pid]
description:
Reference to the process pid key
nodetype: leaf (list key) (ro)
type: leafref
description:
State parameters related to monitored processes
nodetype: container (ro)
description:
The process pid
nodetype: leaf (ro)
type: uint64
description:
The process name
nodetype: leaf (ro)
type: string
description:
Current process command line arguments. Arguments with
a parameter (e.g., --option 10 or -option=10) should be
represented as a single element of the list with the
argument name and parameter together. Flag arguments, i.e.,
those without a parameter should also be in their own list
element.
nodetype: leaf-list (ro)
type: string
description:
The time at which this process started,
relative to the UNIX epoch. The system must be
synchronized such that the start-time can be
reported accurately, otherwise it should not be reported.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
CPU time consumed by this process in user mode in
nanoseconds.
nodetype: leaf (ro)
type: oc-yang:counter64
units: nanoseconds
description:
CPU time consumed by this process in kernel mode.
nodetype: leaf (ro)
type: oc-yang:counter64
units: nanoseconds
description:
The percentage of CPU that is being used by the process.
nodetype: leaf (ro)
type: oc-types:percentage
description:
Bytes allocated and still in use by the process
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The percentage of RAM that is being used by the process.
nodetype: leaf (ro)
type: oc-types:percentage
description:
Top-level container for Syslog messages.
nodetype: container (rw)
description:
Configuration data for Syslog messages.
nodetype: container (rw)
description:
Specifies that only messages of the given severity (or
greater severity) are sent over the RPC.
This is analogous to differentiating which severity is to be
sent to legacy Syslog servers, as opposed to local buffer or
files.
nodetype: leaf (rw)
type: oc-log:syslog-severity
description:
Operational state data for a Syslog messages.
nodetype: container (ro)
description:
Specifies that only messages of the given severity (or
greater severity) are sent over the RPC.
This is analogous to differentiating which severity is to be
sent to legacy Syslog servers, as opposed to local buffer or
files.
nodetype: leaf (ro)
type: oc-log:syslog-severity
description:
Syslog messages the client is Subscribing to. This is all
messages currently configured to be sent according to
syslog-severity.
nodetype: container (ro)
description:
Message payload. If other leafs within this container not
supported, this leaf MAY include the entire message,
inclding pri, procid, app-name etc..
nodetype: leaf (ro)
type: string
description:
The Priority value (PRIVAL) represents both the
Facility and Severity.
nodetype: leaf (ro)
type: uint8
description:
The APP-NAME field SHOULD identify the device or
application that originated the message.
nodetype: leaf (ro)
type: string
description:
PROCID is a value that is included in the message, having
no interoperable meaning, except that a change in the value
indicates there has been a discontinuity in syslog
reporting.
nodetype: leaf (ro)
type: string
description:
The MSGID SHOULD identify the type of message. For
example, a firewall might use the MSGID 'TCPIN' for
incoming TCP traffic and the MSGID 'TCPOUT' for outgoing
TCP traffic.
nodetype: leaf (ro)
type: string
description:
Enclosing container for list of debugs to enable.
nodetype: container (rw)
description:
List of debugging entries.
nodetype: list (rw)
list keys: [service]
description:
Reference to the debug-enable service key.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for debug service entries.
nodetype: container (rw)
description:
Enumeration of all services which can have debugging enabled.
Vendors are to augment this base identity with their platform
or OS specific debug options.
nodetype: leaf (rw)
type: identityref
description:
Enable and disable debugging.
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data for enabled debugs.
nodetype: container (ro)
description:
Enumeration of all services which can have debugging enabled.
Vendors are to augment this base identity with their platform
or OS specific debug options.
nodetype: leaf (ro)
type: identityref
description:
Enable and disable debugging.
nodetype: leaf (ro)
type: boolean
default: false
description:
Container for license model
nodetype: container (rw)
description:
Enclosing container for list of licenses
nodetype: container (rw)
description:
List of licenses.
nodetype: list (rw)
list keys: [license-id]
description:
Reference to license id list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for license
nodetype: container (rw)
description:
License ID. A string that uniquelly identifies the license. The
platform should list all the licenses it supports being activated.
nodetype: leaf (rw)
type: string
description:
The contents of the licence (if required) - which may be
supplied as a binary blob, or a simple string value. If this
value is considered sensitive, it may be read as an empty value.
nodetype: leaf (rw)
type: union
type: binary
type: string
description:
The activation state of the license.
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data for license.
nodetype: container (ro)
description:
License ID. A string that uniquelly identifies the license. The
platform should list all the licenses it supports being activated.
nodetype: leaf (ro)
type: string
description:
The contents of the licence (if required) - which may be
supplied as a binary blob, or a simple string value. If this
value is considered sensitive, it may be read as an empty value.
nodetype: leaf (ro)
type: union
type: binary
type: string
description:
The activation state of the license.
nodetype: leaf (ro)
type: boolean
default: false
description:
The license description.
nodetype: leaf (ro)
type: string
description:
The date and time at which the license was issued, expressed as the
number of nanoseconds since the Unix Epoch
(January 1, 1970, 00:00 UTC).
nodetype: leaf (ro)
type: uint64
description:
The date and time at which the license will expire, expressed as the
number of nanoseconds since the Unix Epoch
(January 1, 1970, 00:00 UTC). Zero if it does not expire.
nodetype: leaf (ro)
type: uint64
description:
The license is in use. Different from active. This states that the
license is effectively being used in addition to being active. If
license for feature X was activated but feature X is not being used,
then this should be false.
nodetype: leaf (ro)
type: boolean
description:
The license has expired.
nodetype: leaf (ro)
type: boolean
description:
The license is valid. Can be activated in the system or platform.
nodetype: leaf (ro)
type: boolean
description:
Top-level container for ssh server
nodetype: container (rw)
description:
Configuration data for the system ssh server
nodetype: container (rw)
description:
Enables the ssh server. The ssh server is enabled by
default.
nodetype: leaf (rw)
type: boolean
default: true
description:
Set the protocol version for SSH connections to the system
nodetype: leaf (rw)
type: enumeration
default: V2
description:
Set the idle timeout in seconds on terminal connections to
the system for the protocol.
nodetype: leaf (rw)
type: uint16
units: seconds
description:
Set a limit on the number of connection attempts per
minute to the system for the protocol.
nodetype: leaf (rw)
type: uint16
units: conn/min
description:
Set a limit on the number of simultaneous active terminal
sessions to the system for the protocol (e.g., ssh,
telnet, ...)
nodetype: leaf (rw)
type: uint16
description:
Operational state data for the system ssh server
nodetype: container (ro)
description:
Enables the ssh server. The ssh server is enabled by
default.
nodetype: leaf (ro)
type: boolean
default: true
description:
Set the protocol version for SSH connections to the system
nodetype: leaf (ro)
type: enumeration
default: V2
description:
Set the idle timeout in seconds on terminal connections to
the system for the protocol.
nodetype: leaf (ro)
type: uint16
units: seconds
description:
Set a limit on the number of connection attempts per
minute to the system for the protocol.
nodetype: leaf (ro)
type: uint16
units: conn/min
description:
Set a limit on the number of simultaneous active terminal
sessions to the system for the protocol (e.g., ssh,
telnet, ...)
nodetype: leaf (ro)
type: uint16
description:
Top-level container for telnet terminal servers
nodetype: container (rw)
description:
Configuration data for telnet
nodetype: container (rw)
description:
Enables the telnet server. Telnet is disabled by
default
nodetype: leaf (rw)
type: boolean
default: false
description:
Set the idle timeout in seconds on terminal connections to
the system for the protocol.
nodetype: leaf (rw)
type: uint16
units: seconds
description:
Set a limit on the number of connection attempts per
minute to the system for the protocol.
nodetype: leaf (rw)
type: uint16
units: conn/min
description:
Set a limit on the number of simultaneous active terminal
sessions to the system for the protocol (e.g., ssh,
telnet, ...)
nodetype: leaf (rw)
type: uint16
description:
Operational state data for telnet
nodetype: container (ro)
description:
Enables the telnet server. Telnet is disabled by
default
nodetype: leaf (ro)
type: boolean
default: false
description:
Set the idle timeout in seconds on terminal connections to
the system for the protocol.
nodetype: leaf (ro)
type: uint16
units: seconds
description:
Set a limit on the number of connection attempts per
minute to the system for the protocol.
nodetype: leaf (ro)
type: uint16
units: conn/min
description:
Set a limit on the number of simultaneous active terminal
sessions to the system for the protocol (e.g., ssh,
telnet, ...)
nodetype: leaf (ro)
type: uint16
description:
Top-level container for clock configuration data
nodetype: container (rw)
description:
Configuration data for system clock
nodetype: container (rw)
description:
The TZ database name to use for the system, such
as 'Europe/Stockholm'.
nodetype: leaf (rw)
type: timezone-name-type
description:
Operational state data for system clock
nodetype: container (ro)
description:
The TZ database name to use for the system, such
as 'Europe/Stockholm'.
nodetype: leaf (ro)
type: timezone-name-type
description:
Enclosing container for the list of CPU cores on the
system
nodetype: container (ro)
description:
List of CPU cores on the system (including logical CPUs
on hyperthreaded systems), keyed by either a numerical
index, or the ALL value for an entry representing the
aggregation across all CPUs.
nodetype: list (ro)
list keys: [index]
description:
Reference to list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational state data for the system CPU(s)
nodetype: container (ro)
description:
The CPU index for each processor core on the system. On a
single-core system, the index should be zero. The ALL
index signifies an aggregation of the CPU utilization
statistics over all cores in the system.
nodetype: leaf (ro)
type: union
type: enumeration
type: uint32
description:
Total CPU utilization.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent running in user space.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent running in kernel space.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent running low-priority (niced)
user processes.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent idle.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent waiting for I/O.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent servicing hardware interrupts.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Percentage of CPU time spent servicing software interrupts
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
If supported by the system, this reports the time interval
over which the min/max/average statistics are computed by
the system.
nodetype: leaf (ro)
type: oc-types:stat-interval
description:
The absolute time at which the minimum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The absolute time at which the maximum value occurred.
The value is the timestamp in nanoseconds relative to
the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
Enclosing container for DNS resolver data
nodetype: container (rw)
description:
Configuration data for the DNS resolver
nodetype: container (rw)
description:
An ordered list of domains to search when resolving
a host name.
nodetype: leaf-list (rw)
type: oc-inet:domain-name
description:
Operational state data for the DNS resolver
nodetype: container (ro)
description:
An ordered list of domains to search when resolving
a host name.
nodetype: leaf-list (ro)
type: oc-inet:domain-name
description:
Enclosing container for DNS resolver list
nodetype: container (rw)
description:
List of the DNS servers that the resolver should query.
When the resolver is invoked by a calling application, it
sends the query to the first name server in this list. If
no response has been received within 'timeout' seconds,
the resolver continues with the next server in the list.
If no response is received from any server, the resolver
continues with the first server again. When the resolver
has traversed the list 'attempts' times without receiving
any response, it gives up and returns an error to the
calling application.
Implementations MAY limit the number of entries in this
list.
nodetype: list (rw)
list keys: [address]
description:
References the configured address of the DNS server
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each DNS resolver
nodetype: container (rw)
description:
The address of the DNS server, can be either IPv4
or IPv6.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
The port number of the DNS server.
nodetype: leaf (rw)
type: oc-inet:port-number
default: 53
description:
Operational state data for each DNS resolver
nodetype: container (ro)
description:
The address of the DNS server, can be either IPv4
or IPv6.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
The port number of the DNS server.
nodetype: leaf (ro)
type: oc-inet:port-number
default: 53
description:
Enclosing container for list of static host entries
nodetype: container (rw)
description:
List of static host entries
nodetype: list (rw)
list keys: [hostname]
description:
Reference to the hostname list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for static host entries
nodetype: container (rw)
description:
Hostname for the static DNS entry
nodetype: leaf (rw)
type: string
description:
Additional aliases for the hostname
nodetype: leaf-list (rw)
type: string
description:
List of IPv4 addresses for the host entry
nodetype: leaf-list (rw)
type: oc-inet:ipv4-address
description:
List of IPv6 addresses for the host entry
nodetype: leaf-list (rw)
type: oc-inet:ipv6-address
description:
Operational state data for static host entries
nodetype: container (ro)
description:
Hostname for the static DNS entry
nodetype: leaf (ro)
type: string
description:
Additional aliases for the hostname
nodetype: leaf-list (ro)
type: string
description:
List of IPv4 addresses for the host entry
nodetype: leaf-list (ro)
type: oc-inet:ipv4-address
description:
List of IPv6 addresses for the host entry
nodetype: leaf-list (ro)
type: oc-inet:ipv6-address
description:
Top-level container for system's MAC address configuration and state
nodetype: container (rw)
description:
Configuration data for routing MAC address.
nodetype: container (rw)
description:
Any packets destined to this MAC address must be sent through the
routing pipeline by the system. This MAC address is used to identify
routed packets in addition to any other MAC addresses that the system
may already have been using to perform routing.
It is not expected that this MAC address will be used as the
source MAC address of any routed packet, as the source MAC address of
any packets generated by the system, or a MAC address used in ARP
response. This MAC address may not be allocated from the block of
MAC address that system owns. For instance, it's allocation could
be managed by an external controller.
nodetype: leaf (rw)
type: oc-yang:mac-address
description:
Operational state data for routing MAC address.
nodetype: container (ro)
description:
Any packets destined to this MAC address must be sent through the
routing pipeline by the system. This MAC address is used to identify
routed packets in addition to any other MAC addresses that the system
may already have been using to perform routing.
It is not expected that this MAC address will be used as the
source MAC address of any routed packet, as the source MAC address of
any packets generated by the system, or a MAC address used in ARP
response. This MAC address may not be allocated from the block of
MAC address that system owns. For instance, it's allocation could
be managed by an external controller.
nodetype: leaf (ro)
type: oc-yang:mac-address
description:
Top-level container for system memory data
nodetype: container (rw)
description:
Configuration data for system memory
nodetype: container (rw)
description:
Operational state data for system memory
nodetype: container (ro)
description:
Counters for tracking system memory errors
nodetype: container (ro)
description:
Count of correctable ECC errors. Systems with ECC memory
are capable of correcting Single-bit ECC errors.
nodetype: leaf (ro)
type: uint64
description:
Count of uncorrectable ECC errors. Systems with ECC
memory are capable of detecting multi-bit ECC errors,
but cannot correct them.
nodetype: leaf (ro)
type: uint64
description:
Count of total ECC errors, this includes both correctable
and uncorrectable ECC errors.
nodetype: leaf (ro)
type: uint64
description:
Reports the total physical memory available on the
system.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Memory reserved for system use
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Memory that has been used and not available for allocation.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Memory that is not used and is available for allocation.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Top-level container for NTP configuration and state
nodetype: container (rw)
description:
Configuration data for NTP client.
nodetype: container (rw)
description:
Enables and disables the NTP protocol and indicates that the system should
attempt to synchronize the system clock with an NTP server
from the servers defined in the 'ntp/server' list.
nodetype: leaf (rw)
type: boolean
default: false
description:
Enable or disable NTP authentication -- when enabled, the
system will only use packets containing a trusted
authentication key to synchronize the time.
nodetype: leaf (rw)
type: boolean
default: false
description:
Operational state data for NTP services.
nodetype: container (ro)
description:
Enables and disables the NTP protocol and indicates that the system should
attempt to synchronize the system clock with an NTP server
from the servers defined in the 'ntp/server' list.
nodetype: leaf (ro)
type: boolean
default: false
description:
Enable or disable NTP authentication -- when enabled, the
system will only use packets containing a trusted
authentication key to synchronize the time.
nodetype: leaf (ro)
type: boolean
default: false
description:
Count of the number of NTP packets received that were not
processed due to authentication mismatch.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Enclosing container for list of NTP authentication keys
nodetype: container (rw)
description:
List of NTP authentication keys
nodetype: list (rw)
list keys: [key-id]
description:
Reference to auth key-id list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for NTP auth keys
nodetype: container (rw)
description:
Integer identifier used by the client and server to
designate a secret key. The client and server must use
the same key id.
nodetype: leaf (rw)
type: uint16
description:
Encryption type used for the NTP authentication key
nodetype: leaf (rw)
type: identityref
description:
NTP authentication key value
nodetype: leaf (rw)
type: string
description:
Operational state data for NTP auth keys
nodetype: container (ro)
description:
Integer identifier used by the client and server to
designate a secret key. The client and server must use
the same key id.
nodetype: leaf (ro)
type: uint16
description:
Encryption type used for the NTP authentication key
nodetype: leaf (ro)
type: identityref
description:
NTP authentication key value
nodetype: leaf (ro)
type: string
description:
Enclosing container for the list of NTP servers
nodetype: container (rw)
description:
List of NTP servers to use for system clock
synchronization. If '/system/ntp/enabled'
is 'true', then the system will attempt to
contact and utilize the specified NTP servers.
nodetype: list (rw)
list keys: [address]
description:
References the configured address or hostname of the
NTP server.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for an NTP server.
nodetype: container (rw)
description:
The address or hostname of the NTP server.
nodetype: leaf (rw)
type: oc-inet:host
description:
The port number of the NTP server.
nodetype: leaf (rw)
type: oc-inet:port-number
default: 123
description:
Version number to put in outgoing NTP packets
nodetype: leaf (rw)
type: uint8
default: 4
description:
The desired association type for this NTP server.
nodetype: leaf (rw)
type: enumeration
default: SERVER
description:
Indicates whether this server should enable burst
synchronization or not.
nodetype: leaf (rw)
type: boolean
default: false
description:
Indicates whether this server should be preferred
or not.
nodetype: leaf (rw)
type: boolean
default: false
description:
The network instance used to find this server.
nodetype: leaf (rw)
type: oc-ni:network-instance-ref
description:
Source address to use on outgoing NTP packets
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Operational state data for an NTP server.
nodetype: container (ro)
description:
The address or hostname of the NTP server.
nodetype: leaf (ro)
type: oc-inet:host
description:
The port number of the NTP server.
nodetype: leaf (ro)
type: oc-inet:port-number
default: 123
description:
Version number to put in outgoing NTP packets
nodetype: leaf (ro)
type: uint8
default: 4
description:
The desired association type for this NTP server.
nodetype: leaf (ro)
type: enumeration
default: SERVER
description:
Indicates whether this server should enable burst
synchronization or not.
nodetype: leaf (ro)
type: boolean
default: false
description:
Indicates whether this server should be preferred
or not.
nodetype: leaf (ro)
type: boolean
default: false
description:
The network instance used to find this server.
nodetype: leaf (ro)
type: oc-ni:network-instance-ref
description:
Source address to use on outgoing NTP packets
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Indicates the level of the server in the NTP hierarchy. As
stratum number increases, the accuracy is degraded. Primary
servers are stratum while a maximum value of 16 indicates
unsynchronized. The values have the following specific
semantics:
| 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
nodetype: leaf (ro)
type: uint8
description:
The total round-trip delay to the reference clock, in nanoseconds.
nodetype: leaf (ro)
type: int64
units: nanoseconds
description:
The maximum error inherent in the measurement, accumulated over the
stratum levels from the reference clock.
nodetype: leaf (ro)
type: int64
units: nanoseconds
description:
Estimate of the current time offset from the peer. This is
the time difference of the peer's clock minus the local clock.
nodetype: leaf (ro)
type: int64
units: nanoseconds
description:
Polling interval of the peer
nodetype: leaf (ro)
type: uint32
units: seconds
description:
Container for Openflow model
nodetype: container (rw)
description:
Container for the Openflow controllers model
nodetype: container (rw)
description:
The Openflow Switch connects to all Openflow controllers
configured
nodetype: list (rw)
list keys: [name]
description:
The name identifies the controller.
nodetype: leaf (list key) (rw)
type: leafref
description:
Container for the Openflow controller config.
nodetype: container (rw)
description:
Name of this Openflow controller. All connections
for the same controller need to have the same name.
nodetype: leaf (rw)
type: string
description:
Container for the Openflow controller state.
nodetype: container (ro)
description:
Name of this Openflow controller. All connections
for the same controller need to have the same name.
nodetype: leaf (ro)
type: string
description:
Enclosing container for list of controller connections
nodetype: container (rw)
description:
List of connections to the OpenFlow controller.
The Openflow switch always connects to configured Openflow
controllers. Each controller can have more than one
connection, called auxiliary Openflow connections.
nodetype: list (rw)
list keys: [aux-id]
description:
Reference to auxiliary id list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for OpenFlow controller connections
nodetype: container (rw)
description:
Controller auxiliary ID. Must be 0 for the main controller.
One controller may have multiple auxiliary connections as
specified by the Openflow protocol. Besides configuring the
main controller, it is also possible to configure auxiliary
connections. The main controller must have the aux-id
set to zero. All others must have an aux-id different
from 0.
nodetype: leaf (rw)
type: of-types:auxiliary-id
description:
Optional value for servicing auxiliary connections with
different priorities.
nodetype: leaf (rw)
type: uint8
description:
The IP address of the controller.
nodetype: leaf (rw)
type: oc-inet:ip-address
description:
Controller port to use.
nodetype: leaf (rw)
type: oc-inet:port-number
default: 6653
description:
Controller transport protocol used.
nodetype: leaf (rw)
type: of-types:transport
default: TCP
description:
Certificate ID is used for TLS connections. When installed,
certificates are associated with an ID. This ID specifies the
certificate to use in a TLS connection.
nodetype: leaf (rw)
type: string
description:
Optionally specify the source interface for the
controller connection.
nodetype: leaf (rw)
type: oc-if:base-interface-ref
description:
Operational state data for OpenFlow controller
connections
nodetype: container (ro)
description:
Controller auxiliary ID. Must be 0 for the main controller.
One controller may have multiple auxiliary connections as
specified by the Openflow protocol. Besides configuring the
main controller, it is also possible to configure auxiliary
connections. The main controller must have the aux-id
set to zero. All others must have an aux-id different
from 0.
nodetype: leaf (ro)
type: of-types:auxiliary-id
description:
Optional value for servicing auxiliary connections with
different priorities.
nodetype: leaf (ro)
type: uint8
description:
The IP address of the controller.
nodetype: leaf (ro)
type: oc-inet:ip-address
description:
Controller port to use.
nodetype: leaf (ro)
type: oc-inet:port-number
default: 6653
description:
Controller transport protocol used.
nodetype: leaf (ro)
type: of-types:transport
default: TCP
description:
Certificate ID is used for TLS connections. When installed,
certificates are associated with an ID. This ID specifies the
certificate to use in a TLS connection.
nodetype: leaf (ro)
type: string
description:
Optionally specify the source interface for the
controller connection.
nodetype: leaf (ro)
type: oc-if:base-interface-ref
description:
When set to true, indicates the connection between the
switch and controller is established.
nodetype: leaf (ro)
type: boolean
description:
Container for the Openflow agent model.
nodetype: container (rw)
description:
Container for the Openflow agent config.
nodetype: container (rw)
description:
Datapath unique ID. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined.
nodetype: leaf (rw)
type: of-types:datapath-id
description:
Failure mode for Openflow.
nodetype: leaf (rw)
type: of-types:failure-mode
description:
Openflow agent connection backoff interval.
nodetype: leaf (rw)
type: uint32
units: seconds
description:
Openflow agent max backoff time.
nodetype: leaf (rw)
type: uint32
units: seconds
description:
Openflow agent inactivity probe period.
nodetype: leaf (rw)
type: uint32
units: seconds
description:
Container for the Openflow agent state.
nodetype: container (ro)
description:
Datapath unique ID. The lower 48-bits are for
a MAC address, while the upper 16-bits are
implementer-defined.
nodetype: leaf (ro)
type: of-types:datapath-id
description:
Failure mode for Openflow.
nodetype: leaf (ro)
type: of-types:failure-mode
description:
Openflow agent connection backoff interval.
nodetype: leaf (ro)
type: uint32
units: seconds
description:
Openflow agent max backoff time.
nodetype: leaf (ro)
type: uint32
units: seconds
description:
Openflow agent inactivity probe period.
nodetype: leaf (ro)
type: uint32
units: seconds
This module defines configuration and operational state data for Openflow.
openconfig-extensions
openconfig-inet-types
openconfig-interfaces
openconfig-openflow-types
openconfig-system