yang_library

Documentation

Overview

This module contains monitoring information about the YANG modules and submodules that are used within a YANG-based server. Copyright (c) 2016 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 7895; see the RFC itself for full legal notices.

Index

• type ModulesState
  • func (modulesState *ModulesState) GetEntityData() *types.CommonEntityData
• type ModulesState_Module
  • func (module *ModulesState_Module) GetEntityData() *types.CommonEntityData
• type ModulesState_Module_ConformanceType
• type ModulesState_Module_Deviation
  • func (deviation *ModulesState_Module_Deviation) GetEntityData() *types.CommonEntityData
• type ModulesState_Module_Submodule
  • func (submodule *ModulesState_Module_Submodule) GetEntityData() *types.CommonEntityData

Types

type ModulesState

type ModulesState struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Contains a server-specific identifier representing the current set of
	// modules and submodules.  The server MUST change the value of this leaf if
	// the information represented by the 'module' list instances has changed. The
	// type is string. This attribute is mandatory.
	ModuleSetId interface{}

	// Each entry represents one revision of one module currently supported by the
	// server. The type is slice of ModulesState_Module.
	Module []*ModulesState_Module
}

ModulesState Contains YANG module monitoring information.

func (*ModulesState) GetEntityData

func (modulesState *ModulesState) GetEntityData() *types.CommonEntityData

type ModulesState_Module

type ModulesState_Module struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The YANG module or submodule name. The type is
	// string with length: 1..18446744073709551615.
	Name interface{}

	// This attribute is a key. The YANG module or submodule revision date. A
	// zero-length string is used if no revision statement is present in the YANG
	// module or submodule. The type is one of the following types: string with
	// pattern: \d{4}-\d{2}-\d{2}, or string with length: 0..0.
	Revision interface{}

	// Contains a URL that represents the YANG schema resource for this module or
	// submodule. This leaf will only be present if there is a URL available for
	// retrieval of the schema for this entry. The type is string.
	Schema interface{}

	// The XML namespace identifier for this module. The type is string. This
	// attribute is mandatory.
	Namespace interface{}

	// List of YANG feature names from this module that are supported by the
	// server, regardless of whether they are defined in the module or any
	// included submodule. The type is slice of string with length:
	// 1..18446744073709551615.
	Feature []interface{}

	// Indicates the type of conformance the server is claiming for the YANG
	// module identified by this entry. The type is ConformanceType. This
	// attribute is mandatory.
	ConformanceType interface{}

	// List of YANG deviation module names and revisions used by this server to
	// modify the conformance of the module associated with this entry.  Note that
	// the same module can be used for deviations for multiple modules, so the
	// same entry MAY appear within multiple 'module' entries. The deviation
	// module MUST be present in the 'module' list, with the same name and
	// revision values. The 'conformance-type' value will be 'implement' for the
	// deviation module. The type is slice of ModulesState_Module_Deviation.
	Deviation []*ModulesState_Module_Deviation

	// Each entry represents one submodule within the parent module. The type is
	// slice of ModulesState_Module_Submodule.
	Submodule []*ModulesState_Module_Submodule
}

ModulesState_Module Each entry represents one revision of one module currently supported by the server.

func (*ModulesState_Module) GetEntityData

func (module *ModulesState_Module) GetEntityData() *types.CommonEntityData

type ModulesState_Module_ConformanceType

type ModulesState_Module_ConformanceType string

ModulesState_Module_ConformanceType represents for the YANG module identified by this entry.

const (
	// Indicates that the server implements one or more
	// protocol-accessible objects defined in the YANG module
	// identified in this entry.  This includes deviation
	// statements defined in the module.
	// For YANG version 1.1 modules, there is at most one
	// module entry with conformance type 'implement' for a
	// particular module name, since YANG 1.1 requires that,
	// at most, one revision of a module is implemented.
	// For YANG version 1 modules, there SHOULD NOT be more
	// than one module entry for a particular module name.
	ModulesState_Module_ConformanceType_implement ModulesState_Module_ConformanceType = "implement"

	// Indicates that the server imports reusable definitions
	// from the specified revision of the module but does
	// not implement any protocol-accessible objects from
	// this revision.
	// Multiple module entries for the same module name MAY
	// exist.  This can occur if multiple modules import the
	// same module but specify different revision dates in
	// the import statements.
	ModulesState_Module_ConformanceType_import_ ModulesState_Module_ConformanceType = "import"
)

type ModulesState_Module_Deviation

type ModulesState_Module_Deviation struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The YANG module or submodule name. The type is
	// string with length: 1..18446744073709551615.
	Name interface{}

	// This attribute is a key. The YANG module or submodule revision date. A
	// zero-length string is used if no revision statement is present in the YANG
	// module or submodule. The type is one of the following types: string with
	// pattern: \d{4}-\d{2}-\d{2}, or string with length: 0..0.
	Revision interface{}
}

ModulesState_Module_Deviation List of YANG deviation module names and revisions used by this server to modify the conformance of the module associated with this entry. Note that the same module can be used for deviations for multiple modules, so the same entry MAY appear within multiple 'module' entries. The deviation module MUST be present in the 'module' list, with the same name and revision values. The 'conformance-type' value will be 'implement' for the deviation module.

func (*ModulesState_Module_Deviation) GetEntityData

func (deviation *ModulesState_Module_Deviation) GetEntityData() *types.CommonEntityData

type ModulesState_Module_Submodule

type ModulesState_Module_Submodule struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The YANG module or submodule name. The type is
	// string with length: 1..18446744073709551615.
	Name interface{}

	// This attribute is a key. The YANG module or submodule revision date. A
	// zero-length string is used if no revision statement is present in the YANG
	// module or submodule. The type is one of the following types: string with
	// pattern: \d{4}-\d{2}-\d{2}, or string with length: 0..0.
	Revision interface{}

	// Contains a URL that represents the YANG schema resource for this module or
	// submodule. This leaf will only be present if there is a URL available for
	// retrieval of the schema for this entry. The type is string.
	Schema interface{}
}

ModulesState_Module_Submodule Each entry represents one submodule within the parent module.

func (*ModulesState_Module_Submodule) GetEntityData

func (submodule *ModulesState_Module_Submodule) GetEntityData() *types.CommonEntityData