NETCONF Configuration Guide
YANG API Reference
ietf-netconf-monitoring
26 min
ietf netconf monitoring module description netconf monitoring module all elements in this module are read only this version of this yang module is part of rfc 6022; yang tree diagram module ietf netconf monitoring + ro netconf state + ro capabilities \| + ro capability inet\ uri + ro datastores \| + ro datastore \[name] \| + ro name netconf datastore type + ro schemas + ro schema \[identifier version format] + ro identifier string + ro version string + ro format identityref + ro namespace inet\ uri + ro location union rpcs + x get schema + w input \| + w identifier string \| + w version? string \| + w format? identityref + ro output + ro data? \<anydata> resources resource list path access /netconf state read only /netconf state/capabilities read only /netconf state/capabilities/capability read only /netconf state/datastores read only /netconf state/datastores/datastore read only /netconf state/datastores/datastore/name read only /netconf state/schemas read only /netconf state/schemas/schema read only /netconf state/schemas/schema/identifier read only /netconf state/schemas/schema/version read only /netconf state/schemas/schema/format read only /netconf state/schemas/schema/namespace read only /netconf state/schemas/schema/location read only detailed nodes /netconf state path /netconf state node type container description the netconf state container is the root of the monitoring data model access read only /netconf state/capabilities path /netconf state/capabilities node type container description contains the list of netconf capabilities supported by the server access read only /netconf state/capabilities/capability path /netconf state/capabilities/capability node type leaf list description list of netconf capabilities supported by the server access read only data type constraints the uri type represents a uniform resource identifier (uri) as defined by the rule 'uri' in rfc 3986 objects using the uri type must be in us ascii encoding, and must be normalized as described by rfc 3986 sections 6 2 1, 6 2 2 1, and 6 2 2 2 characters that can be represented without using percent encoding are represented as characters (without percent encoding), and all case insensitive characters are set to lowercase except for hexadecimal digits within a percent encoded triplet, which are normalized to uppercase as described in section 6 2 2 1 of rfc 3986 the purpose of this normalization is to help provide unique uris note that this normalization is not sufficient to provide uniqueness two uris that are textually distinct after this normalization may still be equivalent objects using the uri type may restrict the schemes that they permit for example, 'data ' and 'urn ' schemes might not be appropriate a zero length uri is not a valid uri this can be used to express 'uri absent' where required in the value set and its semantics, this type is equivalent to the uri smiv2 textual convention defined in rfc 5017 /netconf state/datastores path /netconf state/datastores node type container description contains the list of netconf configuration datastores access read only /netconf state/datastores/datastore path /netconf state/datastores/datastore node type list description list of netconf configuration datastores supported by the netconf server and related information access read only /netconf state/datastores/datastore/name path /netconf state/datastores/datastore/name node type leaf description name of the datastore associated with this list entry access read only data type constraints enumeration with options running startup operational /netconf state/schemas path /netconf state/schemas node type container description contains the list of data model schemas supported by the server access read only /netconf state/schemas/schema path /netconf state/schemas/schema node type list description list of data model schemas supported by the server access read only /netconf state/schemas/schema/identifier path /netconf state/schemas/schema/identifier node type leaf description identifier to uniquely reference the schema the identifier is used in the operation and may be used for other purposes such as file retrieval for modeling languages that support or require a data model name (e g , yang module name) the identifier must match that name for yang data models, the identifier is the name of the module or submodule in other cases, an identifier such as a filename may be used instead access read only data type /netconf state/schemas/schema/version path /netconf state/schemas/schema/version node type leaf description version of the schema supported multiple versions may be supported simultaneously by a netconf server each version must be reported individually in the schema list, i e , with same identifier, possibly different location, but different version for yang data models, version is the value of the most recent yang 'revision' statement in the module or submodule, or the empty string if no 'revision' statement is present access read only data type /netconf state/schemas/schema/format path /netconf state/schemas/schema/format node type leaf description the data modeling language the schema is written in (currently xsd, yang, yin, rng, or rnc) for yang data models, 'yang' format must be supported and 'yin' format may also be provided access read only data type constraints identityref with options yang /netconf state/schemas/schema/namespace path /netconf state/schemas/schema/namespace node type leaf description the xml namespace defined by the data model for yang data models, this is the module's namespace if the list entry describes a submodule, this field contains the namespace of the module to which the submodule belongs access read only data type constraints the uri type represents a uniform resource identifier (uri) as defined by the rule 'uri' in rfc 3986 objects using the uri type must be in us ascii encoding, and must be normalized as described by rfc 3986 sections 6 2 1, 6 2 2 1, and 6 2 2 2 characters that can be represented without using percent encoding are represented as characters (without percent encoding), and all case insensitive characters are set to lowercase except for hexadecimal digits within a percent encoded triplet, which are normalized to uppercase as described in section 6 2 2 1 of rfc 3986 the purpose of this normalization is to help provide unique uris note that this normalization is not sufficient to provide uniqueness two uris that are textually distinct after this normalization may still be equivalent objects using the uri type may restrict the schemes that they permit for example, 'data ' and 'urn ' schemes might not be appropriate a zero length uri is not a valid uri this can be used to express 'uri absent' where required in the value set and its semantics, this type is equivalent to the uri smiv2 textual convention defined in rfc 5017 mandatory yes /netconf state/schemas/schema/location path /netconf state/schemas/schema/location node type leaf list description one or more locations from which the schema can be retrieved this list should contain at least one entry per schema a schema entry may be located on a remote file system (e g , reference to file system for ftp retrieval) or retrieved directly from a server supporting the operation (denoted by the value 'netconf') access read only data type constraints multiple constraints enumeration with options netconf the uri type represents a uniform resource identifier (uri) as defined by the rule 'uri' in rfc 3986 objects using the uri type must be in us ascii encoding, and must be normalized as described by rfc 3986 sections 6 2 1, 6 2 2 1, and 6 2 2 2 characters that can be represented without using percent encoding are represented as characters (without percent encoding), and all case insensitive characters are set to lowercase except for hexadecimal digits within a percent encoded triplet, which are normalized to uppercase as described in section 6 2 2 1 of rfc 3986 the purpose of this normalization is to help provide unique uris note that this normalization is not sufficient to provide uniqueness two uris that are textually distinct after this normalization may still be equivalent objects using the uri type may restrict the schemes that they permit for example, 'data ' and 'urn ' schemes might not be appropriate a zero length uri is not a valid uri this can be used to express 'uri absent' where required in the value set and its semantics, this type is equivalent to the uri smiv2 textual convention defined in rfc 5017 rpcs get schema path access /get schema/input read write /get schema/input/identifier read write /get schema/input/version read write /get schema/input/format read write /get schema/output read write /get schema/output/data read write /get schema/input path /get schema/input node type container description no description available access read write /get schema/input/identifier path /get schema/input/identifier node type leaf description identifier for the schema list entry access read write data type mandatory yes /get schema/input/version path /get schema/input/version node type leaf description version of the schema requested if this parameter is not present, and more than one version of the schema exists on the server, a 'data not unique' error is returned, as described above access read write data type /get schema/input/format path /get schema/input/format node type leaf description the data modeling language of the schema if this parameter is not present, and more than one formats of the schema exists on the server, a 'data not unique' error is returned, as described above access read write data type constraints identityref with options yang /get schema/output path /get schema/output node type container description no description available access read write /get schema/output/data path /get schema/output/data node type anydata description contains the schema content access read write
