Extensions
abstract
Summary
| Name | abstract |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 387 |
| Source | yuma-ncx.yang line 387 |
cli
Summary
| Name | cli |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 396 |
| Source | yuma-ncx.yang line 396 |
default
Summary
| Name | default |
| Module | yang-smi |
| Version | 2008-03-20 |
DEFVAL value provided in an OBJECT-TYPE macro. |
Details
| Argument | default |
| YIN Element | 0 |
| Version | 2008-03-20 |
| File | yang-smi |
| Line | 34 |
| Source | yang-smi.yang line 34 |
default
Summary
| Name | default |
| Module | ietf-yang-smiv2 |
| Version | 2011-04-14 |
DEFVAL value provided in an OBJECT-TYPE macro. |
Details
| Argument | default |
| YIN Element | 0 |
| Version | 2011-04-14 |
| File | ietf-yang-smiv2 |
| Line | 37 |
| Source | ietf-yang-smiv2.yang line 37 |
default-deny-all
Summary
| Name | default-deny-all |
| Module | ietf-netconf-acm |
| Version | 2011-12-23 |
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' to have read, write, or execute access to the node. An explicit access control rule is required for all other users. The 'default-deny-all' extension MAY appear within a data definition statement, 'rpc' statement, or 'notification' statement. It is ignored otherwise. |
Details
| Version | 2011-12-23 |
| File | ietf-netconf-acm |
| Line | 82 |
| Source | ietf-netconf-acm.yang line 82 |
default-deny-write
Summary
| Name | default-deny-write |
| Module | ietf-netconf-acm |
| Version | 2011-12-23 |
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 have write access to the node. An explicit access control rule is required for all other users. The 'default-deny-write' extension MAY appear within a data definition statement. It is ignored otherwise. |
Details
| Version | 2011-12-23 |
| File | ietf-netconf-acm |
| Line | 67 |
| Source | ietf-netconf-acm.yang line 67 |
default-parm
Summary
| Name | default-parm |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 or they will be mistaken for CLI parameter names. This option is somewhat risky because any unrecognized parameter without any prefix (- or --) will be tried as the default parameter type, instead of catching the unknown parameter error. It can also be useful though, for assigning file name parameters through shell expansion, or if there is only one parameter. |
Details
| Argument | parm |
| YIN Element | 1 |
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 404 |
| Source | yuma-ncx.yang line 404 |
default-parm-equals-ok
Summary
| Name | default-parm-equals-ok |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 '=' in the default parm string value.
This option is quite risky because any unrecognized
parameter without any prefix (- or --) will be tried
as the default parameter type, instead of catching
the unknown parameter error. This includes strings containing
an equals sign, so an unknown parameter error will never
be generated.
rpc foo {
input {
ncx:default-parm a;
ncx:default-parm-equals-ok;
leaf a { type string; }
leaf b { type int32; }
}
}
yangcli> foo bogus-parm=fred
This will interpreted as if parameter 'a' were entered:
yangcli> foo a='bogus-parm=fred'
|
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 426 |
| Source | yuma-ncx.yang line 426 |
display-hint
Summary
| Name | display-hint |
| Module | yang-smi |
| Version | 2008-03-20 |
DISPLAY-HINT value provided in a TEXTUAL-CONVENTION macro. |
Details
| Argument | hint |
| YIN Element | 0 |
| Version | 2008-03-20 |
| File | yang-smi |
| Line | 28 |
| Source | yang-smi.yang line 28 |
display-hint
Summary
| Name | display-hint |
| Module | ietf-yang-smiv2 |
| Version | 2011-04-14 |
DISPLAY-HINT value provided in a TEXTUAL-CONVENTION macro. |
Details
| Argument | hint |
| YIN Element | 0 |
| Version | 2011-04-14 |
| File | ietf-yang-smiv2 |
| Line | 31 |
| Source | ietf-yang-smiv2.yang line 31 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | ietf-netconf |
| Version | 2011-03-08 |
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' protocol operations, then the following unqualified XML attribute is supported within the 'filter' element, within a 'get' or 'get-config' protocol operation: type : optional attribute with allowed value strings 'subtree' and 'xpath'. If missing, the default value is 'subtree'. If the 'xpath' feature is supported, then the following unqualified XML attribute is also supported: select: optional attribute containing a string representing an XPath expression. The 'type' attribute must be equal to 'xpath' if this attribute is present. |
Details
| Version | 2011-03-08 |
| File | ietf-netconf |
| Line | 60 |
| Source | ietf-netconf.yang line 60 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | yuma-netconf |
| Version | 2011-05-30 |
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 the 'filter' element, within a 'get' or 'get-config' protocol operation: type : optional attribute with allowed value strings 'subtree' and 'xpath'. If missing, the default value is 'subtree'. If the 'xpath' feature is supported, then the following unqualified XML attribute is also supported: select: optional attribute containing a string representing an XPath expression. The 'type' attribute must be equal to 'xpath' if this attribute is present. |
Details
| Version | 2011-05-30 |
| File | yuma-netconf |
| Line | 71 |
| Source | yuma-netconf.yang line 71 |
hidden
Summary
| Name | hidden |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 affected by this extension. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 460 |
| Source | yuma-ncx.yang line 460 |
max-access
Summary
| Name | max-access |
| Module | ietf-yang-smiv2 |
| Version | 2011-04-14 |
MAX-ACCESS value provided in an OBJECT-TYPE macro. |
Details
| Argument | access |
| YIN Element | 0 |
| Version | 2011-04-14 |
| File | ietf-yang-smiv2 |
| Line | 43 |
| Source | ietf-yang-smiv2.yang line 43 |
metadata
Summary
| Name | metadata |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 following format: [prefix:]typename attribute-name Any YANG typedef of builtin type can be specified as the type name, except 'empty'. Example from get command in netconf.yang: ncx:metadata 'FilterType type'; |
Details
| Argument | syntax-string |
| YIN Element | 1 |
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 471 |
| Source | yuma-ncx.yang line 471 |
no-duplicates
Summary
| Name | no-duplicates |
| Module | yuma-ncx |
| Version | 2012-01-13 |
Used to indicate that no duplicate values are allowed in an ncx:xsdlist leaf or leaf-list object. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 494 |
| Source | yuma-ncx.yang line 494 |
oid
Summary
| Name | oid |
| Module | yang-smi |
| Version | 2008-03-20 |
OBJECT IDENTIFIER value assigned to a particular node. |
Details
| Argument | oid |
| YIN Element | 0 |
| Version | 2008-03-20 |
| File | yang-smi |
| Line | 22 |
| Source | yang-smi.yang line 22 |
oid
Summary
| Name | oid |
| Module | ietf-yang-smiv2 |
| Version | 2011-04-14 |
OBJECT IDENTIFIER value assigned to a particular node. |
Details
| Argument | oid |
| YIN Element | 0 |
| Version | 2011-04-14 |
| File | ietf-yang-smiv2 |
| Line | 25 |
| Source | ietf-yang-smiv2.yang line 25 |
password
Summary
| Name | password |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 500 |
| Source | yuma-ncx.yang line 500 |
qname
Summary
| Name | qname |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 must be 'string', or the 'qname' extension will be ignored. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 599 |
| Source | yuma-ncx.yang line 599 |
root
Summary
| Name | root |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 507 |
| Source | yuma-ncx.yang line 507 |
schema-instance
Summary
| Name | schema-instance |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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
as an instance-identifier apply except:
* predicates for keys are optional;
The dataRule will apply to all instances
of any missing key leaf predicate.
This extension will be ignored unless it is present
in the type-stmt of a typedef-stmt, leaf-stmt,
or leaf-list-stmt, or directly within a leaf-stmt or
leaf-list-stmt.
|
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 611 |
| Source | yuma-ncx.yang line 611 |
secure
Summary
| Name | secure |
| Module | yuma-nacm |
| Version | 2012-01-13 |
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 rule is required for all other users. The 'secure' extension may appear within a data, rpc, or notification node definition. It is ignored otherwise. |
Details
| Version | 2012-01-13 |
| File | yuma-nacm |
| Line | 107 |
| Source | yuma-nacm.yang line 107 |
sil-delete-children-first
Summary
| Name | sil-delete-children-first |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 its
own sub-structures when the SIL edit callback is
invoked. If this extension is present, then any
SIL callbacks for any of the child nodes will be
invoked first instead.
If a child node is a list or a container, and
it also contains an 'ncx:sil-delete-children-first'
extension, then its children will be checked first.
The SIL edit callback will not be invoked for leaf,
leaf-list, or anyxml descendant nodes in this mode.
They will only will called if their parent node
is not getting deleted.
container foo {
ncx:sil-delete-children-first;
list foos {
ncx:sil-delete-children-first;
key a;
leaf a { type string; }
container b {
list c { ... }
}
leaf d { type empty; }
}
}
In this example, assume node /foo gets deleted.
Then the SIL edit callbacks would be done as follows:
1) /foo/foos[a='n']/b (called for row 'n' of /foo/foos)
2) /foo/foos[a='n'] (called for row 'n' of /foo/foos)
3) repeat (1,2) until all rows in /foo/foos are deleted
4) /foo
Note that the SIL edit callback is not done for list
/foo/foos[a='n']/b/c because this extension is
not present in container '/foo/foos/b'.
Note that the SIL edit callback is not done for
nodes /foo/foos[a='n']/a or /foo/foos[a='n']/d because
they are leafs.
|
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 516 |
| Source | yuma-ncx.yang line 516 |
user-write
Summary
| Name | user-write |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 permissions will over-ride all NACM access control rules,
even if NACM is disabled.
This extension does not apply to descendant nodes!
This extension has no effect if config-stmt is false!
The following values are supported:
* create : allow users to create instances of the object
* update : allow users to modify instances of the object
* delete : allow users to delete instances of the object
To dis-allow all user access, provide an empty string
for the 'permitted' parameter (user-write '';)
To allow only create and delete user access, provide
the string 'create delete' for the 'permitted' parameter.
Use this for parameters that cannot be changed once they
are set.
Providing all 3 parameters has the same affect as not using
this extension at all, but can be used anyway.
leaf user-write {
description 'equivalent YANG definition';
type bits {
bit create;
bit update;
bit delete;
}
default 'create update delete';
}
|
Details
| Argument | exceptions |
| YIN Element | 1 |
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 631 |
| Source | yuma-ncx.yang line 631 |
very-secure
Summary
| Name | very-secure |
| Module | yuma-nacm |
| Version | 2012-01-13 |
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 control rule is required for all other users. The 'very-secure' extension may appear within a data, rpc, or notification node definition. It is ignored otherwise. |
Details
| Version | 2012-01-13 |
| File | yuma-nacm |
| Line | 122 |
| Source | yuma-nacm.yang line 122 |
xpath
Summary
| Name | xpath |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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 builtin data type must be 'string', or the 'xpath' extension will be ignored. All data using the 'instance-identifier' built-in type will automatically be processed as an XPath string, so the xpath extension is not needed in that case. |
Details
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 583 |
| Source | yuma-ncx.yang line 583 |
xsdlist
Summary
| Name | xsdlist |
| Module | yuma-ncx |
| Version | 2012-01-13 |
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-section for a string. |
Details
| Argument | type |
| YIN Element | 1 |
| Version | 2012-01-13 |
| File | yuma-ncx |
| Line | 569 |
| Source | yuma-ncx.yang line 569 |