netconfcentral logo

Extensions

Extension Abstract
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.
abstract Makes the complex-type abstract.
abstract Makes the complex-type abstract.
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.
also-augments The argument is a string that identifies a node in the schema tree and is the same argument that is defined for the YANG argument statement
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. The argument is the alternate name to use. It must be a valid YANG identifier.
annotation This extension allows for defining metadata annotations in YANG modules. The 'md:annotation' statement can appear only at the top level of a YANG module. The argument of the 'md:annotation' statement defines the name of the annotation. Syntactically it i...
annotation This extension allows for defining metadata annotations in YANG modules. The 'md:annotation' statement can appear only at the top level of a YANG module or submodule, i.e., it becomes a new alternative in the ABNF production rule for 'body-stmts' (Sectio...
augment-structure This extension is used to specify an augmentation to a YANG data structure defined with the 'structure' statement. It is intended to describe hierarchical data independent of protocol context or specific message encoding format. This statement has almos...
augment-yang-data This extension is used to specify an augmentation to conceptual data defined with the 'yang-data' statement. It is intended to describe hierarchical data independent of protocol context or specific message encoding format. This statement has almost the s...
catalog-organization This extension specifies the organization name that should be used within the module catalogue on the device for the specified YANG module. It stores a pithy string where the YANG organization statement may contain more details.
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 {...
complex-type Defines a complex-type.
complex-type Defines a complex-type.
datapath Used within a container or anyxml definition to indicate that the object path for the data node should be sent in the value as an attribute. The SIL-SA parser will use the datapath attribute to select the object template to use for parsing, instead of ge...
default-deny-all Copy of IETF version of 'very-secure' extension.
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 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 'recovery session' to have read, write, or execute access to the node. An explicit access contro...
default-deny-write Copy of IETF version of '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 Used to indicate that the data model node represents a sensitive security system parameter. If present, the NETCONF server will only allow the designated 'recovery session' to have write access to the node. An explicit access control rule is required fo...
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...
derivedUnits This extension allows the use of an SI (or even a non SI) unit for a specific physic concept. This helps a NETCONF server to accept different scales or magnitude orders for the same meaning. For example, length can be expressed into 'astronomical-units' ...
display-hint The display-hint statement takes as an argument the DISPLAY-HINT assigned to an SMIv2 textual convention.
equation An equation is a list of expressions. The equation is considered well known and easy to obtain a consensus to within the scientific community. It is outside the scope of this YANG model to describe what the equation does. Instead, this YANG model refers ...
errmsg Used within a data node statement to define a custom error-message filed within an 'rpc-error' or 'error' structure for some or all error conditions. The string format is restricted to plain text with the exception of the 2 character sequence '%s'. This ...
errmsg-apptag Used within an errmsg statement to define an error-app-tag value that will filter this errmsg. Multiple errmsg-tag and/or errmsg-apptag values form a conceptual OR expression. The 'apptagstr' argument must be the error-app-tag value that will be matched....
errmsg-lang Used within an errmsg statement to define the language code value that will filter this errmsg. Only one errmsg-lang statement may appear within an errmsg statement. The 'langstr' value will be compared to the 'errmsg-lang' CLI variable setting. If the st...
errmsg-parm Used within an errmsg statement to define a parameter for expansion within the errmsg basestr. There should be the correct number of expected parameters for the corresponding 'basestr' format string. The 'parmstr' argument must be an XPath path expressio...
errmsg-tag Used within an errmsg statement to define an error-tag value that will filter this errmsg. Multiple errmsg-tag and/or errmsg-apptag values form a conceptual OR expression. The 'tagstr' argument must be the error-tag value that will be matched.
exclusive-rpc Used within an rpc definition statement to indicate that the RPC is not allowed to be called concurrently by different sessions. The server will return an in-use error if another session is currently invoking the RPC operation and this extension is prese...
expression An expression is part of an equation. Two expressions in an equation are equivalent. An expression is a list of unknown or variables linked by operations. The expression is considered well known and easy to obtain a consensus to within the scientific com...
extends Defines the base type of a complex-type.
extends Defines the base type of a complex-type.
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...
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 ...
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.
instance Declares an instance of the given complex type.
instance Declares an instance of the given complex type.
instance-list Declares a list of instances of the given complex type
instance-list Declares a list of instances of the given complex type
instance-type Tells to which type instance the instance identifier refers.
instance-type Tells to which type instance the instance identifier refers to.
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...
mount-point The argument 'label' is a YANG identifier, i.e., it is of the type 'yang:yang-identifier'. The 'mount-point' statement MUST NOT be used in a YANG version 1 module, neither explicitly nor via a 'uses' statement. The 'mount-point' statement MAY be present ...
name An optional name to use an equation as an unknown for functional programming. The name MUST be of type function:variableName.
no-duplicates Used to indicate that no duplicate values are allowed in an ncx:xsdlist leaf or leaf-list object.
no-nvstore Used within a configuration data node definition statement to indicate that configuration changes made to the object will not be stored in non-volatile storage. The configuration node will be handled in an implementation-specific manner. There is no argum...
no-sil-delete-children-first Used within a configuration data node definition statement to indicate that the --sil-delete-children-first parameter should be ignored for this subtree, if it is set to 'true'. Faster server performance can be achieved by deleting an entire subtree at o...
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.
openconfig-encrypted-value This extension provides an annotation on schema nodes to indicate that the corresponding value should be stored and reported in encrypted form. Clients reading the configuration or applied configuration for the node should expect to receive only the encr...
openconfig-hashed-value This extension provides an annotation on schema nodes to indicate that the corresponding value should be stored and reported in hashed form. Hash algorithms are by definition not reversible. Clients reading the configuration or applied configuration for ...
openconfig-hashed-value This extension provides an annotation on schema nodes to indicate that the corresponding value should be stored and reported in hashed form. Hash algorithms are by definition not reversible. Clients reading the configuration or applied configuration for ...
openconfig-version The OpenConfig version number for the module. This is expressed as a semantic version number of the form: x.y.z where: * x corresponds to the major version, * y corresponds to a minor version, * z corresponds to a patch version. This version correspon...
openconfig-version The OpenConfig version number for the module. This is expressed as a semantic version number of the form: x.y.z where: * x corresponds to the major version, * y corresponds to a minor version, * z corresponds to a patch version. This version correspon...
openconfig-version The OpenConfig version number for the module. This is expressed as a semantic version number of the form: x.y.z where: * x corresponds to the major version, * y corresponds to a minor version, * z corresponds to a patch version. This version correspon...
operational The operational annotation is specified in the context of a grouping, leaf, or leaf-list within a YANG module. It indicates that the nodes within the context are derived state on the device. OpenConfig data models divide nodes into the following three ca...
origin This extension specifies the name of the origin that the YANG module falls within. This allows multiple overlapping schema trees to be used on a single network element without requiring module based prefixing of paths.
password Used to indicate the data type for the leaf is really a password. For yangcli-pro, this extension causes a password to be printed as ****. For netconfd-pro this extension has the following effects: - In subtree filtering, a content-match node will ...
posix-pattern Provides a POSIX ERE regular expression pattern statement as an alternative to YANG regular expresssions based on XML Schema Datatypes. It is used the same way as the standard YANG pattern statement defined in RFC6020 and RFC7950, but takes an argument th...
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...
regexp-posix This extension indicates that the regular expressions included within the YANG module specified are conformant with the POSIX regular expression format rather than the W3C standard that is specified by RFC6020 and RFC7950.
related-state The related-state statement is used to identify a node that contains additional operational state associated for a config true node. The format of the argument is the same as for a leafref's 'path' statement. The related-state statement can be specified...
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-root Used within a container definition to indicate it is really a root container for a conceptual NETCONF operations, instead of just a container. The container is expected to be empty. Any top-level rpc-stmt can be specified using a QName value with the sam...
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...
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-type for the node. An explicit access cont...
sil-aio-get2 Used within a data definition statement to define the GET2 retrieval mechanism. This extension affects the descendant data nodes. This extension can be used in a container or list to force the server to treat that data subtree as a terminal node for GET2...
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 ...
sil-force-replace-replay Used within a configuration data node definition statement to indicate that the SIL (or SIL-SA) callback should be invoked even for nodes that are not changing, during a replace operation. All SIL callbacks for child nodes in the replace request (where t...
sil-force-replay Used within a configuration data node definition statement to indicate that the SIL (or SIL-SA) callback should be invoked even for nodes that are not changing. At least one descendant-or-self node must be changing in order for any of the SIL callbacks f...
sil-priority Used to control the order that SIL or SIL-SA callbacks are invoked for specific objects. If this extension is used within a configuration database object then the SIL priority for the object will be assigned the value of the 'prio' argument. Only the or...
sil-test-get-when Used within a data definition statement to define the --sil-get-test-when CLI parameter behavior for a single object. This extension does not affect the descendant data nodes. The 'boolval' argument must be the string 'true' or 'false'; If 'true' the obj...
structure This extension is used to specify a YANG data structure that represents conceptual data defined in YANG. It is intended to describe hierarchical data independent of protocol context or specific message encoding format. Data definition statements within ...
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 ...
subscription-state-notification This statement applies only to notifications. It indicates that the notification is a subscription state change notification. Therefore, it does not participate in a regular event stream and does not need to be specifically subscribed to in order to be ...
symbol To provide a known name that represents this type. Adds nothing to a NETCONF server.
telemetry-atomic The telemetry-atomic annotation is specified in the context of a subtree (containre, or list), and indicates that all nodes within the subtree are always updated together within the data model. For example, all elements under the subtree may be updated as...
telemetry-on-change The telemetry-on-change annotation is specified in the context of a particular subtree (container, or list) or leaf within the YANG schema. Where specified, it indicates that the value stored by the nodes within the context change their value only in resp...
units To provide a unit to logical functions, such as groupings. A container can be made of leafs, and have a unit on its own.
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 'exceptions' argument is a list of operations that users are permitted to invoke for the specified node. Thes...
value The value part of the equation which MUST be of type function:variable. The result of the equation. It can be used to directly configure the server. Or the value is returned by the server as a result of a call, a simulation, a mathematical process. This...
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...
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-type for the node. An explicit a...
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...
xpath-operational-ok Used within a data-definition statement for a configuration data node to alter the must-stmt and when-stmt found within the data node. This allows an XPath expression in such a node to reference config=false data nodes. This property does not apply to an...
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...
yang-data This extension is used to specify a YANG data template that represents conceptual data defined in YANG. It is intended to describe hierarchical data independent of protocol context or specific message-encoding format. Data definition statements within a ...