|
abstract
|
Used with object definitions to indicate that they
do not represent CLI or NETCONF configuration database
data instances. Instead, the node is simply an object
identifier, an 'error-info' extension, or some other
abstract data structure. |
|
alias
|
The alias statement introduces an SMIv2 descriptor. The body of
the alias statement is expected to contain an oid statement that
provides the numeric OID associated with the descriptor. |
|
alt-name
|
Used within a data node definition to specify an alternate
name for the node. The --alt-names parameter must
be enabled for these names to be used. |
|
cli
|
Used within a container definition to indicate it is
only used as a conceptual container for a set of CLI parameters.
A top-level container containing this extension will not
be included in any NETCONF configuration databases. |
|
cli-text-block
|
If this extension is present in an empty container
or list, it will be treated in unit-test parsing as a
container or list of ordered text commands, 1 per line.
Line extension is needed to wrap a command into
many lines.
Example YANG:
container setup {... |
|
default
|
DEFVAL value provided in an OBJECT-TYPE macro. |
|
default-deny-all
|
Used to indicate that the data model node
controls a very sensitive security system parameter.
If present, and the NACM module is enabled (i.e.,
/nacm/enable-nacm object equals 'true'), the NETCONF server
will only allow the designated 'recovery session'... |
|
default-deny-all
|
Copy of IETF version of 'very-secure' extension. |
|
default-deny-write
|
Used to indicate that the data model node
represents a sensitive security system parameter.
If present, and the NACM module is enabled (i.e.,
/nacm/enable-nacm object equals 'true'), the NETCONF server
will only allow the designated 'recovery session' to... |
|
default-deny-write
|
Copy of IETF version of 'secure' extension. |
|
default-parm
|
Used within a CLI container or rpc definition to specify a
leaf parameter within the CLI container or rpc input
section, that is used as the default if no parameter name
is entered.
These values must not begin with a dash (-) or
double dash (--) sequence... |
|
default-parm-equals-ok
|
Used within a CLI container or rpc definition to specify a
leaf parameter within the CLI container or rpc input
section, that is used as the default if no parameter name
is entered.
This can be used in addition to ncx:default-parm to
allow an equals sign... |
|
defval
|
The defval statement takes as an argument a default value
defined by an SMIv2 DEFVAL clause. Note that the value is in
the SMIv2 value space defined by the SMIv2 syntax of the
corresponding object and not in the YANG value space
defined by the correspond... |
|
display-hint
|
DISPLAY-HINT value provided in a TEXTUAL-CONVENTION macro. |
|
display-hint
|
The display-hint statement takes as an argument the DISPLAY-HINT
assigned to an SMIv2 textual convention. |
|
get-filter-element-attributes
|
If this extension is present within an 'anyxml'
statement named 'filter', which must be conceptually
defined within the RPC input section for the <get>
and <get-config> protocol operations, then the
following unqualified XML attribute is supported
within ... |
|
get-filter-element-attributes
|
If this extension is present within the
an 'anyxml' statement named 'filter', which must be
conceptually defined within the RPC input section
for the 'get' and 'get-config' RPC operations,
then the following unqualified XML attribute is
supported within t... |
|
help
|
Used within a rpc or data definition statement to
provide a short help text string for CLI
and other applications to use in addition to
the description statement.
The 'helptext' argument is the help text string,
which should be 60 characters or less in l... |
|
hidden
|
Used to prevent publication of a YANG data object.
Will be ignored for typedefs and other constructs.
If present, that node and any sub-nodes will be ignored
when generating HTML documentation or cYANG output.
The yangdump -f=copy mode will not be affect... |
|
implied
|
If an SMIv2 INDEX object is preceded by the IMPLIED keyword, then
the implied statement is present in the YANG module and takes as
an argument the name of the IMPLIED index object. |
|
max-access
|
The max-access statement takes as an argument the MAX-ACCESS
assigned to an SMIv2 object definition.
The MAX-ACCESS value is SMIv2 specific and has no impact on
the access provided to YANG objects through protocols such
as NETCONF. |
|
metadata
|
Used to define an XML attribute to be associated with a
data-def-stmt node. Only optional metadata can be
defined. Errors for missing XML attributes (except
as specified by the YANG language) will not be
checked automatically.
The syntax string has the... |
|
no-duplicates
|
Used to indicate that no duplicate values are allowed
in an ncx:xsdlist leaf or leaf-list object. |
|
notif-root
|
Used within a container definition to indicate it is
really a root container for a conceptual NETCONF
notification events, instead of just an empty container. |
|
oid
|
OBJECT IDENTIFIER value assigned to a particular node. |
|
oid
|
The oid statement takes as an argument the object identifier
assigned to an SMIv2 definition. The object identifier value
is written in decimal dotted notation. |
|
optional-key
|
This extension is used to allow the client to create
a new instance of a resource without providing a
value for the key leaf containing this statement.
This extension is ignored for NETCONF, and only
applies to YANG-API resources and fields.
This extensio... |
|
password
|
Used to indicate the data type for the leaf is really
a password. Only the encrypted version of the password
is allowed to be generated in any output. |
|
qname
|
Used to indicate that the content of a data type
is a Qualified Name. This is needed to properly
evaluate the namespace prefix, if used.
The qname extension may appear within the type-stmt,
within a typedef, leaf, or leaf-list. The builtin
data type mu... |
|
root
|
Used within a container definition to indicate it is
really a root container for a conceptual NETCONF database,
instead of just an empty container. This is needed
for yuma to correctly process any RPC method
that contains a 'config' parameter. |
|
rpc-hook
|
Used within a leaf definition (type should be string)
to indicate it is really a symbolic link to the
specified RPC function. The data type format is
module-name:rpc-name (yt:FeatureSpec) |
|
rpc-root
|
Used within a container definition to indicate it is
really a root container for a conceptual NETCONF
operations, instead of just a container.
This container is allowed to have leaf children
which include an 'rpc-hook' extension. This allows
REST-API met... |
|
schema-instance
|
Used to indicate that the typedef or type statement
for a string data type really identifies a
special schema-instance node, not a generic string.
A schema-instance value string is an unrestricted YANG
instance-identifier expression. All the same rules
... |
|
secure
|
Used to indicate that the data model node
represents a sensitive security system parameter.
If present, the NETCONF server will only allow
the designated 'superuser' to have write or execute
default nacm-rights for the node. An explicit access
control r... |
|
sil-delete-children-first
|
Used within a container or list definition to indicate
that the SIL callbacks for descendant nodes should
be invoked first, when a data node instance of
the object containing this extension is deleted.
Normally, the parent node is expected to delete all ... |
|
subid
|
The subid statement takes as an argument the last sub-identifier
of the object identifier assigned to an SMIv2 definition. The
sub-identifier value is a single positive decimal natural number.
The subid statement may not be used as a substatement to any
... |
|
urlpath
|
Used within a leaf or leaf-list definition to indicate it is
really a REST URI path string, not a plain string. |
|
user-write
|
Used within database configuration data definition
statements to control user write access to the
database object containing this statement.
The 'permitted' argument is a list of operations
that users are permitted to invoke for the specified node.
These... |
|
very-secure
|
Used to indicate that the data model node
controls a very sensitive security system parameter.
If present, the NETCONF server will only allow
the designated 'superuser' to have read, write, or execute
default nacm-rights for the node. An explicit access... |
|
xpath
|
Used to indicate that the content of a data type
is an XPath expression. This is needed to properly
evaluate the namespace prefixes within the expression.
The xpath extension may appear within the type-stmt,
within a typedef, leaf, or leaf-list. The bu... |
|
xsdlist
|
Used to indicate the leaf string type is really an
XSD list, which is a series of whitespace separated
strings. The type argument represents the data type
to use for the list members, for validation purposes.
Allowed to be present within the type sub-sec... |
