Extensions
abstract
Summary
| Name | abstract |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 374 |
| Source | yuma-ncx.yang line 374 |
cli
Summary
| Name | cli |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 383 |
| Source | yuma-ncx.yang line 383 |
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-parm
Summary
| Name | default-parm |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 391 |
| Source | yuma-ncx.yang line 391 |
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 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | ietf-netconf |
| Version | 2010-05-18 |
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 | 2010-05-18 |
| File | ietf-netconf |
| Line | 59 |
| Source | ietf-netconf.yang line 59 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | yuma-netconf |
| Version | 2010-05-24 |
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 | 2010-05-24 |
| File | yuma-netconf |
| Line | 66 |
| Source | yuma-netconf.yang line 66 |
hidden
Summary
| Name | hidden |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 413 |
| Source | yuma-ncx.yang line 413 |
metadata
Summary
| Name | metadata |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 424 |
| Source | yuma-ncx.yang line 424 |
no-duplicates
Summary
| Name | no-duplicates |
| Module | yuma-ncx |
| Version | 2009-12-21 |
Used to indicate that no duplicate values are allowed in an ncx:xsdlist leaf or leaf-list object. |
Details
| Version | 2009-12-21 |
| File | yuma-ncx |
| Line | 447 |
| Source | yuma-ncx.yang line 447 |
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 |
password
Summary
| Name | password |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 453 |
| Source | yuma-ncx.yang line 453 |
qname
Summary
| Name | qname |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 499 |
| Source | yuma-ncx.yang line 499 |
root
Summary
| Name | root |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 460 |
| Source | yuma-ncx.yang line 460 |
schema-instance
Summary
| Name | schema-instance |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 511 |
| Source | yuma-ncx.yang line 511 |
secure
Summary
| Name | secure |
| Module | yuma-nacm |
| Version | 2010-02-21 |
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 | 2010-02-21 |
| File | yuma-nacm |
| Line | 100 |
| Source | yuma-nacm.yang line 100 |
very-secure
Summary
| Name | very-secure |
| Module | yuma-nacm |
| Version | 2010-02-21 |
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 | 2010-02-21 |
| File | yuma-nacm |
| Line | 115 |
| Source | yuma-nacm.yang line 115 |
xpath
Summary
| Name | xpath |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 483 |
| Source | yuma-ncx.yang line 483 |
xsdlist
Summary
| Name | xsdlist |
| Module | yuma-ncx |
| Version | 2009-12-21 |
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 | 2009-12-21 |
| File | yuma-ncx |
| Line | 469 |
| Source | yuma-ncx.yang line 469 |