Extensions
abstract
Summary
| Name | abstract |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 408 |
| Source | yuma-ncx.yang line 408 |
alias
Summary
| Name | alias |
| Module | ietf-yang-smiv2 |
| Version | 2012-06-22 |
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. |
Details
| Argument | descriptor |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 116 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 116 |
alt-name
Summary
| Name | alt-name |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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. |
Details
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 25 |
| Source | yumaworks-extensions.yang line 25 |
cli
Summary
| Name | cli |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 417 |
| Source | yuma-ncx.yang line 417 |
cli-text-block
Summary
| Name | cli-text-block |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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 {
ut:cli-text-block;
}
Example test script or conf file usage:
setup {
run test1-script
get-config source=running
lock target=candidate
some-long-command parms='this is a wrapped
line in a text block'
}
|
Details
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 67 |
| Source | yumaworks-extensions.yang line 67 |
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-deny-all
Summary
| Name | default-deny-all |
| Module | ietf-netconf-acm |
| Version | 2012-02-22 |
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 | 2012-02-22 |
| File | ietf-netconf-acm |
| Line | 73 |
| Source | ietf-netconf-acm.yang line 73 |
default-deny-all
Summary
| Name | default-deny-all |
| Module | yuma-nacm |
| Version | 2012-10-05 |
Copy of IETF version of 'very-secure' extension. |
Details
| Version | 2012-10-05 |
| File | yuma-nacm |
| Line | 128 |
| Reference | RFC 6536 |
| Source | yuma-nacm.yang line 128 |
default-deny-write
Summary
| Name | default-deny-write |
| Module | ietf-netconf-acm |
| Version | 2012-02-22 |
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 | 2012-02-22 |
| File | ietf-netconf-acm |
| Line | 58 |
| Source | ietf-netconf-acm.yang line 58 |
default-deny-write
Summary
| Name | default-deny-write |
| Module | yuma-nacm |
| Version | 2012-10-05 |
Copy of IETF version of 'secure' extension. |
Details
| Version | 2012-10-05 |
| File | yuma-nacm |
| Line | 122 |
| Reference | RFC 6536 |
| Source | yuma-nacm.yang line 122 |
default-parm
Summary
| Name | default-parm |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 425 |
| Source | yuma-ncx.yang line 425 |
default-parm-equals-ok
Summary
| Name | default-parm-equals-ok |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 447 |
| Source | yuma-ncx.yang line 447 |
defval
Summary
| Name | defval |
| Module | ietf-yang-smiv2 |
| Version | 2012-06-22 |
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 corresponding YANG data type. |
Details
| Argument | value |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 94 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 94 |
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 | 2012-06-22 |
The display-hint statement takes as an argument the DISPLAY-HINT assigned to an SMIv2 textual convention. |
Details
| Argument | format |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 68 |
| Reference | RFC 2579: Textual Conventions for SMIv2 |
| Source | ietf-yang-smiv2.yang line 68 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | ietf-netconf |
| Version | 2011-06-01 |
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 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-06-01 |
| File | ietf-netconf |
| Line | 56 |
| Source | ietf-netconf.yang line 56 |
get-filter-element-attributes
Summary
| Name | get-filter-element-attributes |
| Module | yuma-netconf |
| Version | 2012-10-05 |
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 | 2012-10-05 |
| File | yuma-netconf |
| Line | 76 |
| Source | yuma-netconf.yang line 76 |
help
Summary
| Name | help |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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 length. |
Details
| Argument | helptext |
| YIN Element | 1 |
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 93 |
| Source | yumaworks-extensions.yang line 93 |
hidden
Summary
| Name | hidden |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 481 |
| Source | yuma-ncx.yang line 481 |
implied
Summary
| Name | implied |
| Module | ietf-yang-smiv2 |
| Version | 2012-06-22 |
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. |
Details
| Argument | index |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 106 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 106 |
max-access
Summary
| Name | max-access |
| Module | ietf-yang-smiv2 |
| Version | 2012-06-22 |
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. |
Details
| Argument | access |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 81 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 81 |
metadata
Summary
| Name | metadata |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 492 |
| Source | yuma-ncx.yang line 492 |
no-duplicates
Summary
| Name | no-duplicates |
| Module | yuma-ncx |
| Version | 2012-11-10 |
Used to indicate that no duplicate values are allowed in an ncx:xsdlist leaf or leaf-list object. |
Details
| Version | 2012-11-10 |
| File | yuma-ncx |
| Line | 515 |
| Source | yuma-ncx.yang line 515 |
notif-root
Summary
| Name | notif-root |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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. |
Details
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 32 |
| Source | yumaworks-extensions.yang line 32 |
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 | 2012-06-22 |
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. |
Details
| Argument | value |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 129 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 129 |
optional-key
Summary
| Name | optional-key |
| Module | yumaworks-yang-api |
| Version | 2012-06-28 |
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 extension is ignored unless it appears directly within a 'leaf' data definition statement. |
Details
| Version | 2012-06-28 |
| File | yumaworks-yang-api |
| Line | 25 |
| Source | yumaworks-yang-api.yang line 25 |
password
Summary
| Name | password |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 521 |
| Source | yuma-ncx.yang line 521 |
qname
Summary
| Name | qname |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 620 |
| Source | yuma-ncx.yang line 620 |
root
Summary
| Name | root |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 528 |
| Source | yuma-ncx.yang line 528 |
rpc-hook
Summary
| Name | rpc-hook |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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) |
Details
| Argument | rpc |
| YIN Element | 0 |
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 39 |
| Source | yumaworks-extensions.yang line 39 |
rpc-root
Summary
| Name | rpc-root |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
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 method hooks within the data tree. These containers are ignored by NETCONF. |
Details
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 50 |
| Source | yumaworks-extensions.yang line 50 |
schema-instance
Summary
| Name | schema-instance |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 632 |
| Source | yuma-ncx.yang line 632 |
secure
Summary
| Name | secure |
| Module | yuma-nacm |
| Version | 2012-10-05 |
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-10-05 |
| File | yuma-nacm |
| Line | 134 |
| Source | yuma-nacm.yang line 134 |
sil-delete-children-first
Summary
| Name | sil-delete-children-first |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 537 |
| Source | yuma-ncx.yang line 537 |
subid
Summary
| Name | subid |
| Module | ietf-yang-smiv2 |
| Version | 2012-06-22 |
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 top-level node in a YANG document. The subid substatement may be used only as a substatement to a node having a parent node defined with either an smiv2:oid or smiv2:subid substatement. |
Details
| Argument | value |
| YIN Element | 0 |
| Version | 2012-06-22 |
| File | ietf-yang-smiv2 |
| Line | 139 |
| Reference | RFC 2578: Structure of Management Information Version 2 (SMIv2) |
| Source | ietf-yang-smiv2.yang line 139 |
urlpath
Summary
| Name | urlpath |
| Module | yumaworks-extensions |
| Version | 2013-01-27 |
Used within a leaf or leaf-list definition to indicate it is really a REST URI path string, not a plain string. |
Details
| Version | 2013-01-27 |
| File | yumaworks-extensions |
| Line | 61 |
| Source | yumaworks-extensions.yang line 61 |
user-write
Summary
| Name | user-write |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 652 |
| Source | yuma-ncx.yang line 652 |
very-secure
Summary
| Name | very-secure |
| Module | yuma-nacm |
| Version | 2012-10-05 |
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-10-05 |
| File | yuma-nacm |
| Line | 149 |
| Source | yuma-nacm.yang line 149 |
xpath
Summary
| Name | xpath |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 604 |
| Source | yuma-ncx.yang line 604 |
xsdlist
Summary
| Name | xsdlist |
| Module | yuma-ncx |
| Version | 2012-11-10 |
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-11-10 |
| File | yuma-ncx |
| Line | 590 |
| Source | yuma-ncx.yang line 590 |