netconf_monitoring

package
v0.0.0-...-50def94 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

NETCONF Monitoring Module. All elements in this module are read-only.

Copyright (c) 2010 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 6022; see the RFC itself for full legal notices.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetSchema 

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

	Input GetSchema_Input

	Output GetSchema_Output
}

GetSchema This operation is used to retrieve a schema from the NETCONF server.

Positive Response: 

The NETCONF server returns the requested schema.

Negative Response: 

If requested schema does not exist, the <error-tag> is
'invalid-value'.

If more than one schema matches the requested parameters, the
<error-tag> is 'operation-failed', and <error-app-tag> is
'data-not-unique'.

func (*GetSchema) GetEntityData 

func (getSchema *GetSchema) GetEntityData() *types.CommonEntityData

type GetSchema_Input 

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

	// Identifier for the schema list entry. The type is string. This attribute is
	// mandatory.
	Identifier interface{}

	// 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. The type is
	// string.
	Version interface{}

	// 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. The type is one of
	// the following: RncYinRngXsdYang.
	Format interface{}
}

GetSchema_Input

func (*GetSchema_Input) GetEntityData 

func (input *GetSchema_Input) GetEntityData() *types.CommonEntityData

type GetSchema_Output 

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

	// Contains the schema content. The type is string.
	Data interface{}
}

GetSchema_Output

func (*GetSchema_Output) GetEntityData 

func (output *GetSchema_Output) GetEntityData() *types.CommonEntityData

type NetconfBeep 

type NetconfBeep struct {
}

func (NetconfBeep) String 

func (id NetconfBeep) String() string

type NetconfDatastoreType 

type NetconfDatastoreType string

NetconfDatastoreType represents Enumeration of possible NETCONF datastore types. 

const (
	NetconfDatastoreType_running NetconfDatastoreType = "running"

	NetconfDatastoreType_candidate NetconfDatastoreType = "candidate"

	NetconfDatastoreType_startup NetconfDatastoreType = "startup"
)

type NetconfSoapOverBeep 

type NetconfSoapOverBeep struct {
}

func (NetconfSoapOverBeep) String 

func (id NetconfSoapOverBeep) String() string

type NetconfSoapOverHttps 

type NetconfSoapOverHttps struct {
}

func (NetconfSoapOverHttps) String 

func (id NetconfSoapOverHttps) String() string

type NetconfSsh 

type NetconfSsh struct {
}

func (NetconfSsh) String 

func (id NetconfSsh) String() string

type NetconfState 

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

	// Contains the list of NETCONF capabilities supported by the server.
	Capabilities NetconfState_Capabilities

	// Contains the list of NETCONF configuration datastores.
	Datastores NetconfState_Datastores

	// Contains the list of data model schemas supported by the server.
	Schemas NetconfState_Schemas

	// The sessions container includes session-specific data for NETCONF
	// management sessions.  The session list MUST include all currently active
	// NETCONF sessions.
	Sessions NetconfState_Sessions

	// Statistical data pertaining to the NETCONF server.
	Statistics NetconfState_Statistics
}

NetconfState The netconf-state container is the root of the monitoring data model.

func (*NetconfState) GetEntityData 

func (netconfState *NetconfState) GetEntityData() *types.CommonEntityData

type NetconfState_Capabilities 

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

	// List of NETCONF capabilities supported by the server. The type is slice of
	// string.
	Capability []interface{}
}

NetconfState_Capabilities Contains the list of NETCONF capabilities supported by the server.

func (*NetconfState_Capabilities) GetEntityData 

func (capabilities *NetconfState_Capabilities) GetEntityData() *types.CommonEntityData

type NetconfState_Datastores 

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

	// List of NETCONF configuration datastores supported by the NETCONF server
	// and related information. The type is slice of
	// NetconfState_Datastores_Datastore.
	Datastore []*NetconfState_Datastores_Datastore
}

NetconfState_Datastores Contains the list of NETCONF configuration datastores.

func (*NetconfState_Datastores) GetEntityData 

func (datastores *NetconfState_Datastores) GetEntityData() *types.CommonEntityData

type NetconfState_Datastores_Datastore 

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

	// This attribute is a key. Name of the datastore associated with this list
	// entry. The type is NetconfDatastoreType.
	Name interface{}

	// The NETCONF <lock> and <partial-lock> operations allow a client to lock
	// specific resources in a datastore.  The NETCONF server will prevent changes
	// to the locked resources by all sessions except the one that acquired the
	// lock(s).  Monitoring information is provided for each datastore entry
	// including details such as the session that acquired the lock, the type of
	// lock (global or partial) and the list of locked resources.  Multiple locks
	// per datastore are supported.
	Locks NetconfState_Datastores_Datastore_Locks
}

NetconfState_Datastores_Datastore List of NETCONF configuration datastores supported by the NETCONF server and related information.

func (*NetconfState_Datastores_Datastore) GetEntityData 

func (datastore *NetconfState_Datastores_Datastore) GetEntityData() *types.CommonEntityData

type NetconfState_Datastores_Datastore_Locks 

type NetconfState_Datastores_Datastore_Locks struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YPresence  bool

	// Present if the global lock is set.
	GlobalLock NetconfState_Datastores_Datastore_Locks_GlobalLock

	// List of partial locks. The type is slice of
	// NetconfState_Datastores_Datastore_Locks_PartialLock.
	PartialLock []*NetconfState_Datastores_Datastore_Locks_PartialLock
}

NetconfState_Datastores_Datastore_Locks The NETCONF <lock> and <partial-lock> operations allow a client to lock specific resources in a datastore. The NETCONF server will prevent changes to the locked resources by all sessions except the one that acquired the lock(s).

Monitoring information is provided for each datastore entry including details such as the session that acquired the lock, the type of lock (global or partial) and the list of locked resources. Multiple locks per datastore are supported. This type is a presence type.

func (*NetconfState_Datastores_Datastore_Locks) GetEntityData 

func (locks *NetconfState_Datastores_Datastore_Locks) GetEntityData() *types.CommonEntityData

type NetconfState_Datastores_Datastore_Locks_GlobalLock 

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

	// The session ID of the session that has locked this resource.  Both a global
	// lock and a partial lock MUST contain the NETCONF session-id.  If the lock
	// is held by a session that is not managed by the NETCONF server (e.g., a CLI
	// session), a session id of 0 (zero) is reported. The type is interface{}
	// with range: 0..4294967295. This attribute is mandatory.
	LockedBySession interface{}

	// The date and time of when the resource was locked. The type is string with
	// pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}).
	// This attribute is mandatory.
	LockedTime interface{}
}

NetconfState_Datastores_Datastore_Locks_GlobalLock Present if the global lock is set.

func (*NetconfState_Datastores_Datastore_Locks_GlobalLock) GetEntityData 

func (globalLock *NetconfState_Datastores_Datastore_Locks_GlobalLock) GetEntityData() *types.CommonEntityData

type NetconfState_Datastores_Datastore_Locks_PartialLock 

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

	// This attribute is a key. This is the lock id returned in the <partial-lock>
	// response. The type is interface{} with range: 0..4294967295.
	LockId interface{}

	// The session ID of the session that has locked this resource.  Both a global
	// lock and a partial lock MUST contain the NETCONF session-id.  If the lock
	// is held by a session that is not managed by the NETCONF server (e.g., a CLI
	// session), a session id of 0 (zero) is reported. The type is interface{}
	// with range: 0..4294967295. This attribute is mandatory.
	LockedBySession interface{}

	// The date and time of when the resource was locked. The type is string with
	// pattern: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}).
	// This attribute is mandatory.
	LockedTime interface{}

	// The xpath expression that was used to request the lock.  The select
	// expression indicates the original intended scope of the lock. The type is
	// slice of string.
	Select []interface{}

	// The list of instance-identifiers (i.e., the locked nodes).  The scope of
	// the partial lock is defined by the list of locked nodes. The type is slice
	// of string.
	LockedNode []interface{}
}

NetconfState_Datastores_Datastore_Locks_PartialLock List of partial locks.

func (*NetconfState_Datastores_Datastore_Locks_PartialLock) GetEntityData 

func (partialLock *NetconfState_Datastores_Datastore_Locks_PartialLock) GetEntityData() *types.CommonEntityData

type NetconfState_Schemas 

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

	// List of data model schemas supported by the server. The type is slice of
	// NetconfState_Schemas_Schema.
	Schema []*NetconfState_Schemas_Schema
}

NetconfState_Schemas Contains the list of data model schemas supported by the server.

func (*NetconfState_Schemas) GetEntityData 

func (schemas *NetconfState_Schemas) GetEntityData() *types.CommonEntityData

type NetconfState_Schemas_Schema 

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

	// This attribute is a key. Identifier to uniquely reference the schema.  The
	// identifier is used in the <get-schema> 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. The type is string.
	Identifier interface{}

	// This attribute is a key. 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. The type is string.
	Version interface{}

	// This attribute is a key. 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. The type is
	// one of the following: RncYinRngXsdYang.
	Format interface{}

	// 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. The
	// type is string. This attribute is mandatory.
	Namespace interface{}

	// 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 <get-schema>
	// operation (denoted by the value 'NETCONF'). The type is one of the
	// following types: slice of
	// :go:struct:`NetconfState_Schemas_Schema_Location
	// <ydk/models/netconf_monitoring/NetconfState_Schemas_Schema_Location>`, or
	// slice of string.
	Location []interface{}
}

NetconfState_Schemas_Schema List of data model schemas supported by the server.

func (*NetconfState_Schemas_Schema) GetEntityData 

func (schema *NetconfState_Schemas_Schema) GetEntityData() *types.CommonEntityData

type NetconfState_Schemas_Schema_Location 

type NetconfState_Schemas_Schema_Location string

NetconfState_Schemas_Schema_Location represents <get-schema> operation (denoted by the value 'NETCONF'). 

const (
	NetconfState_Schemas_Schema_Location_NETCONF NetconfState_Schemas_Schema_Location = "NETCONF"
)

type NetconfState_Sessions 

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

	// All NETCONF sessions managed by the NETCONF server MUST be reported in this
	// list. The type is slice of NetconfState_Sessions_Session.
	Session []*NetconfState_Sessions_Session
}

NetconfState_Sessions The sessions container includes session-specific data for NETCONF management sessions. The session list MUST include all currently active NETCONF sessions.

func (*NetconfState_Sessions) GetEntityData 

func (sessions *NetconfState_Sessions) GetEntityData() *types.CommonEntityData

type NetconfState_Sessions_Session 

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

	// This attribute is a key. Unique identifier for the session.  This value is
	// the NETCONF session identifier, as defined in RFC 4741. The type is
	// interface{} with range: 1..4294967295.
	SessionId interface{}

	// Identifies the transport for each session, e.g., 'netconf-ssh',
	// 'netconf-soap', etc. The type is one of the following:
	// NetconfBeepNetconfSshNetconfSoapOverBeepNetconfTlsNetconfSoapOverHttps.
	// This attribute is mandatory.
	Transport interface{}

	// The username is the client identity that was authenticated by the NETCONF
	// transport protocol.  The algorithm used to derive the username is NETCONF
	// transport protocol specific and in addition specific to the authentication
	// mechanism used by the NETCONF transport protocol. The type is string. This
	// attribute is mandatory.
	Username interface{}

	// Host identifier of the NETCONF client.  The value returned is
	// implementation specific (e.g., hostname, IPv4 address, IPv6 address). The
	// type is one of the following types: string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?,
	// or string with pattern:
	// ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?.,
	// or string with length: 1..253.
	SourceHost interface{}

	// Time at the server at which the session was established. The type is string
	// with pattern:
	// \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}). This
	// attribute is mandatory.
	LoginTime interface{}

	// Number of correct <rpc> messages received. The type is interface{} with
	// range: 0..4294967295.
	InRpcs interface{}

	// Number of messages received when an <rpc> message was expected, that were
	// not correct <rpc> messages.  This includes XML parse errors and errors on
	// the rpc layer. The type is interface{} with range: 0..4294967295.
	InBadRpcs interface{}

	// Number of <rpc-reply> messages sent that contained an <rpc-error> element.
	// The type is interface{} with range: 0..4294967295.
	OutRpcErrors interface{}

	// Number of <notification> messages sent. The type is interface{} with range:
	// 0..4294967295.
	OutNotifications interface{}
}

NetconfState_Sessions_Session All NETCONF sessions managed by the NETCONF server MUST be reported in this list.

func (*NetconfState_Sessions_Session) GetEntityData 

func (session *NetconfState_Sessions_Session) GetEntityData() *types.CommonEntityData

type NetconfState_Statistics 

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

	// Date and time at which the management subsystem was started. The type is
	// string with pattern:
	// \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2}).
	NetconfStartTime interface{}

	// Number of sessions silently dropped because an invalid <hello> message was
	// received.  This includes <hello> messages with a 'session-id' attribute,
	// bad namespace, and bad capability declarations. The type is interface{}
	// with range: 0..4294967295.
	InBadHellos interface{}

	// Number of sessions started.  This counter is incremented when a <hello>
	// message with a <session-id> is sent.  'in-sessions' - 'in-bad-hellos' =
	// 'number of correctly started netconf sessions'. The type is interface{}
	// with range: 0..4294967295.
	InSessions interface{}

	// Number of sessions that were abnormally terminated, e.g., due to idle
	// timeout or transport close.  This counter is not incremented when a session
	// is properly closed by a <close-session> operation, or killed by a
	// <kill-session> operation. The type is interface{} with range:
	// 0..4294967295.
	DroppedSessions interface{}

	// Number of correct <rpc> messages received. The type is interface{} with
	// range: 0..4294967295.
	InRpcs interface{}

	// Number of messages received when an <rpc> message was expected, that were
	// not correct <rpc> messages.  This includes XML parse errors and errors on
	// the rpc layer. The type is interface{} with range: 0..4294967295.
	InBadRpcs interface{}

	// Number of <rpc-reply> messages sent that contained an <rpc-error> element.
	// The type is interface{} with range: 0..4294967295.
	OutRpcErrors interface{}

	// Number of <notification> messages sent. The type is interface{} with range:
	// 0..4294967295.
	OutNotifications interface{}
}

NetconfState_Statistics Statistical data pertaining to the NETCONF server.

func (*NetconfState_Statistics) GetEntityData 

func (statistics *NetconfState_Statistics) GetEntityData() *types.CommonEntityData

type NetconfTls 

type NetconfTls struct {
}

func (NetconfTls) String 

func (id NetconfTls) String() string

type Rnc 

type Rnc struct {
}

func (Rnc) String 

func (id Rnc) String() string

type Rng 

type Rng struct {
}

func (Rng) String 

func (id Rng) String() string

type SchemaFormat 

type SchemaFormat struct {
}

func (SchemaFormat) String 

func (id SchemaFormat) String() string

type Transport 

type Transport struct {
}

func (Transport) String 

func (id Transport) String() string

type Xsd 

type Xsd struct {
}

func (Xsd) String 

func (id Xsd) String() string

type Yang 

type Yang struct {
}

func (Yang) String 

func (id Yang) String() string

type Yin 

type Yin struct {
}

func (Yin) String 

func (id Yin) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.