infra_correlator_oper

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

This module contains a collection of YANG definitions for Cisco IOS-XR infra-correlator package operational data.

This module contains definitions for the following management objects: 

suppression: Suppression operational data
correlator: correlator

Copyright (c) 2013-2018 by Cisco Systems, Inc. All rights reserved.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcRuleState 

type AcRuleState string

AcRuleState represents Ac rule state 

const (
	// Rule is in Unapplied state
	AcRuleState_rule_unapplied AcRuleState = "rule-unapplied"

	// Rule is Applied to specified RacksSlots,
	// Contexts and Sources
	AcRuleState_rule_applied AcRuleState = "rule-applied"

	// Rule is Applied to all of router
	AcRuleState_rule_applied_all AcRuleState = "rule-applied-all"
)

type AlAlarmBistate 

type AlAlarmBistate string

AlAlarmBistate represents Al alarm bistate 

const (
	// not available
	AlAlarmBistate_not_available AlAlarmBistate = "not-available"

	// active
	AlAlarmBistate_active AlAlarmBistate = "active"

	// clear
	AlAlarmBistate_clear AlAlarmBistate = "clear"
)

type AlAlarmSeverity 

type AlAlarmSeverity string

AlAlarmSeverity represents Al alarm severity 

const (
	// unknown
	AlAlarmSeverity_unknown AlAlarmSeverity = "unknown"

	// emergency
	AlAlarmSeverity_emergency AlAlarmSeverity = "emergency"

	// alert
	AlAlarmSeverity_alert AlAlarmSeverity = "alert"

	// critical
	AlAlarmSeverity_critical AlAlarmSeverity = "critical"

	// error
	AlAlarmSeverity_error_ AlAlarmSeverity = "error"

	// warning
	AlAlarmSeverity_warning AlAlarmSeverity = "warning"

	// notice
	AlAlarmSeverity_notice AlAlarmSeverity = "notice"

	// informational
	AlAlarmSeverity_informational AlAlarmSeverity = "informational"

	// debugging
	AlAlarmSeverity_debugging AlAlarmSeverity = "debugging"
)

type Correlator 

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

	// Table that contains the database of correlation rules.
	Rules Correlator_Rules

	// Describes buffer utilization and parameters configured.
	BufferStatus Correlator_BufferStatus

	// Correlated alarms Table.
	Alarms Correlator_Alarms

	// Table that contains the ruleset summary info.
	RuleSetSummaries Correlator_RuleSetSummaries

	// Table that contains the ruleset detail info.
	RuleSetDetails Correlator_RuleSetDetails

	// Table that contains the database of correlation rule details.
	RuleDetails Correlator_RuleDetails

	// Table that contains the database of correlation rule summary.
	RuleSummaries Correlator_RuleSummaries
}

Correlator correlator

func (*Correlator) GetEntityData 

func (correlator *Correlator) GetEntityData() *types.CommonEntityData

type Correlator_Alarms 

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

	// One of the correlated alarms. The type is slice of Correlator_Alarms_Alarm.
	Alarm []*Correlator_Alarms_Alarm
}

Correlator_Alarms Correlated alarms Table

func (*Correlator_Alarms) GetEntityData 

func (alarms *Correlator_Alarms) GetEntityData() *types.CommonEntityData

type Correlator_Alarms_Alarm 

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

	// This attribute is a key. Alarm ID. The type is interface{} with range:
	// 0..4294967295.
	AlarmId interface{}

	// Correlation rule name. The type is string.
	RuleName interface{}

	// Context string  for the alarm. The type is string.
	Context interface{}

	// Correlated alarm information.
	AlarmInfo Correlator_Alarms_Alarm_AlarmInfo
}

Correlator_Alarms_Alarm One of the correlated alarms

func (*Correlator_Alarms_Alarm) GetEntityData 

func (alarm *Correlator_Alarms_Alarm) GetEntityData() *types.CommonEntityData

type Correlator_Alarms_Alarm_AlarmInfo 

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

	// Source Identifier(Location).Indicates the node in which the alarm was
	// generated. The type is string.
	SourceId interface{}

	// Time when the alarm was generated. It is expressed in number of
	// milliseconds since 00:00 :00 UTC, January 1, 1970. The type is interface{}
	// with range: 0..18446744073709551615. Units are millisecond.
	Timestamp interface{}

	// Category of the alarm. The type is string.
	Category interface{}

	// Group of messages to which this alarm belongs to. The type is string.
	Group interface{}

	// Alarm code which further qualifies the alarm within a message group. The
	// type is string.
	Code interface{}

	// Severity of the alarm. The type is AlAlarmSeverity.
	Severity interface{}

	// State of the alarm (bistate alarms only). The type is AlAlarmBistate.
	State interface{}

	// Correlation Identifier. The type is interface{} with range: 0..4294967295.
	CorrelationId interface{}

	// Indicates the event id admin-level. The type is bool.
	IsAdmin interface{}

	// Full text of the Alarm. The type is string.
	AdditionalText interface{}
}

Correlator_Alarms_Alarm_AlarmInfo Correlated alarm information

func (*Correlator_Alarms_Alarm_AlarmInfo) GetEntityData 

func (alarmInfo *Correlator_Alarms_Alarm_AlarmInfo) GetEntityData() *types.CommonEntityData

type Correlator_BufferStatus 

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

	// Current buffer usage. The type is interface{} with range: 0..4294967295.
	CurrentSize interface{}

	// Configured buffer size. The type is interface{} with range: 0..4294967295.
	ConfiguredSize interface{}
}

Correlator_BufferStatus Describes buffer utilization and parameters configured

func (*Correlator_BufferStatus) GetEntityData 

func (bufferStatus *Correlator_BufferStatus) GetEntityData() *types.CommonEntityData

type Correlator_RuleDetails 

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

	// Details of one of the correlation rules. The type is slice of
	// Correlator_RuleDetails_RuleDetail.
	RuleDetail []*Correlator_RuleDetails_RuleDetail
}

Correlator_RuleDetails Table that contains the database of correlation rule details

func (*Correlator_RuleDetails) GetEntityData 

func (ruleDetails *Correlator_RuleDetails) GetEntityData() *types.CommonEntityData

type Correlator_RuleDetails_RuleDetail 

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

	// This attribute is a key. Correlation Rule Name. The type is string with
	// length: 1..32.
	RuleName interface{}

	// Time window (in ms) for which root/all messages are kept in correlater
	// before sending them to the logger. The type is interface{} with range:
	// 0..4294967295.
	Timeout interface{}

	// Timeout before root cause alarm. The type is interface{} with range:
	// 0..4294967295.
	RootCauseTimeout interface{}

	// True if the rule is internal. The type is bool.
	Internal interface{}

	// Whether to reissue non-bistate alarms. The type is bool.
	ReissueNonBistate interface{}

	// Reparent. The type is bool.
	Reparent interface{}

	// Whether context correlation is enabled. The type is bool.
	ContextCorrelation interface{}

	// Locations (R/S/M) to which the rule is applied. The type is slice of string
	// with pattern: ([a-zA-Z0-9_]*\d+/){1,2}([a-zA-Z0-9_]*\d+).
	ApplyLocation []interface{}

	// Contexts (Interfaces) to which the rule is applied. The type is slice of
	// string with length: 0..33.
	ApplyContext []interface{}

	// Rule summary, name, etc.
	RuleSummary Correlator_RuleDetails_RuleDetail_RuleSummary

	// Message codes defining the rule. The type is slice of
	// Correlator_RuleDetails_RuleDetail_Codes.
	Codes []*Correlator_RuleDetails_RuleDetail_Codes
}

Correlator_RuleDetails_RuleDetail Details of one of the correlation rules

func (*Correlator_RuleDetails_RuleDetail) GetEntityData 

func (ruleDetail *Correlator_RuleDetails_RuleDetail) GetEntityData() *types.CommonEntityData

type Correlator_RuleDetails_RuleDetail_Codes 

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

	// Category of messages to which this alarm belongs. The type is string.
	Category interface{}

	// Group of messages to which this alarm belongs. The type is string.
	Group interface{}

	// Alarm code which further qualifies the alarm within a message group. The
	// type is string.
	Code interface{}
}

Correlator_RuleDetails_RuleDetail_Codes Message codes defining the rule.

func (*Correlator_RuleDetails_RuleDetail_Codes) GetEntityData 

func (codes *Correlator_RuleDetails_RuleDetail_Codes) GetEntityData() *types.CommonEntityData

type Correlator_RuleDetails_RuleDetail_RuleSummary 

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

	// Correlation Rule Name. The type is string.
	RuleNameXr interface{}

	// Whether the rule is stateful. The type is bool.
	Stateful interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Number of buffered alarms correlated to this rule. The type is interface{}
	// with range: 0..4294967295.
	BufferedAlarmsCount interface{}
}

Correlator_RuleDetails_RuleDetail_RuleSummary Rule summary, name, etc

func (*Correlator_RuleDetails_RuleDetail_RuleSummary) GetEntityData 

func (ruleSummary *Correlator_RuleDetails_RuleDetail_RuleSummary) GetEntityData() *types.CommonEntityData

type Correlator_RuleSetDetails 

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

	// Detail of one of the correlation rulesets. The type is slice of
	// Correlator_RuleSetDetails_RuleSetDetail.
	RuleSetDetail []*Correlator_RuleSetDetails_RuleSetDetail
}

Correlator_RuleSetDetails Table that contains the ruleset detail info

func (*Correlator_RuleSetDetails) GetEntityData 

func (ruleSetDetails *Correlator_RuleSetDetails) GetEntityData() *types.CommonEntityData

type Correlator_RuleSetDetails_RuleSetDetail 

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

	// This attribute is a key. Ruleset Name. The type is string with length:
	// 1..32.
	RuleSetName interface{}

	// Ruleset Name. The type is string.
	RuleSetNameXr interface{}

	// Rules contained in a ruleset. The type is slice of
	// Correlator_RuleSetDetails_RuleSetDetail_Rules.
	Rules []*Correlator_RuleSetDetails_RuleSetDetail_Rules
}

Correlator_RuleSetDetails_RuleSetDetail Detail of one of the correlation rulesets

func (*Correlator_RuleSetDetails_RuleSetDetail) GetEntityData 

func (ruleSetDetail *Correlator_RuleSetDetails_RuleSetDetail) GetEntityData() *types.CommonEntityData

type Correlator_RuleSetDetails_RuleSetDetail_Rules 

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

	// Correlation Rule Name. The type is string.
	RuleNameXr interface{}

	// Whether the rule is stateful. The type is bool.
	Stateful interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Number of buffered alarms correlated to this rule. The type is interface{}
	// with range: 0..4294967295.
	BufferedAlarmsCount interface{}
}

Correlator_RuleSetDetails_RuleSetDetail_Rules Rules contained in a ruleset

func (*Correlator_RuleSetDetails_RuleSetDetail_Rules) GetEntityData 

func (rules *Correlator_RuleSetDetails_RuleSetDetail_Rules) GetEntityData() *types.CommonEntityData

type Correlator_RuleSetSummaries 

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

	// Summary of one of the correlation rulesets. The type is slice of
	// Correlator_RuleSetSummaries_RuleSetSummary.
	RuleSetSummary []*Correlator_RuleSetSummaries_RuleSetSummary
}

Correlator_RuleSetSummaries Table that contains the ruleset summary info

func (*Correlator_RuleSetSummaries) GetEntityData 

func (ruleSetSummaries *Correlator_RuleSetSummaries) GetEntityData() *types.CommonEntityData

type Correlator_RuleSetSummaries_RuleSetSummary 

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

	// This attribute is a key. Ruleset Name. The type is string with length:
	// 1..32.
	RuleSetName interface{}

	// Ruleset Name. The type is string.
	RuleSetNameXr interface{}
}

Correlator_RuleSetSummaries_RuleSetSummary Summary of one of the correlation rulesets

func (*Correlator_RuleSetSummaries_RuleSetSummary) GetEntityData 

func (ruleSetSummary *Correlator_RuleSetSummaries_RuleSetSummary) GetEntityData() *types.CommonEntityData

type Correlator_RuleSummaries 

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

	// One of the correlation rules. The type is slice of
	// Correlator_RuleSummaries_RuleSummary.
	RuleSummary []*Correlator_RuleSummaries_RuleSummary
}

Correlator_RuleSummaries Table that contains the database of correlation rule summary

func (*Correlator_RuleSummaries) GetEntityData 

func (ruleSummaries *Correlator_RuleSummaries) GetEntityData() *types.CommonEntityData

type Correlator_RuleSummaries_RuleSummary 

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

	// This attribute is a key. Correlation Rule Name. The type is string with
	// length: 1..32.
	RuleName interface{}

	// Correlation Rule Name. The type is string.
	RuleNameXr interface{}

	// Whether the rule is stateful. The type is bool.
	Stateful interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Number of buffered alarms correlated to this rule. The type is interface{}
	// with range: 0..4294967295.
	BufferedAlarmsCount interface{}
}

Correlator_RuleSummaries_RuleSummary One of the correlation rules

func (*Correlator_RuleSummaries_RuleSummary) GetEntityData 

func (ruleSummary *Correlator_RuleSummaries_RuleSummary) GetEntityData() *types.CommonEntityData

type Correlator_Rules 

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

	// One of the correlation rules. The type is slice of Correlator_Rules_Rule.
	Rule []*Correlator_Rules_Rule
}

Correlator_Rules Table that contains the database of correlation rules

func (*Correlator_Rules) GetEntityData 

func (rules *Correlator_Rules) GetEntityData() *types.CommonEntityData

type Correlator_Rules_Rule 

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

	// This attribute is a key. Correlation Rule Name. The type is string with
	// length: 1..32.
	RuleName interface{}

	// Correlation Rule Name. The type is string.
	RuleNameXr interface{}

	// Time window (in ms) for which root/all messages are kept in correlater
	// before sending them to the logger. The type is interface{} with range:
	// 0..4294967295.
	Timeout interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Locations (R/S/M) to which the rule is  applied. The type is slice of
	// string with pattern: ([a-zA-Z0-9_]*\d+/){1,2}([a-zA-Z0-9_]*\d+).
	ApplyLocation []interface{}

	// Contexts (Interfaces) to which the rule is applied. The type is slice of
	// string with length: 0..33.
	ApplyContext []interface{}

	// Message codes defining the rule. The type is slice of
	// Correlator_Rules_Rule_Codes.
	Codes []*Correlator_Rules_Rule_Codes
}

Correlator_Rules_Rule One of the correlation rules

func (*Correlator_Rules_Rule) GetEntityData 

func (rule *Correlator_Rules_Rule) GetEntityData() *types.CommonEntityData

type Correlator_Rules_Rule_Codes 

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

	// Category of messages to which this alarm belongs. The type is string.
	Category interface{}

	// Group of messages to which this alarm belongs. The type is string.
	Group interface{}

	// Alarm code which further qualifies the alarm within a message group. The
	// type is string.
	Code interface{}
}

Correlator_Rules_Rule_Codes Message codes defining the rule.

func (*Correlator_Rules_Rule_Codes) GetEntityData 

func (codes *Correlator_Rules_Rule_Codes) GetEntityData() *types.CommonEntityData

type Suppression 

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

	// Table that contains the database of suppression rule summary.
	RuleSummaries Suppression_RuleSummaries

	// Table that contains the database of suppression rule details.
	RuleDetails Suppression_RuleDetails
}

Suppression Suppression operational data

func (*Suppression) GetEntityData 

func (suppression *Suppression) GetEntityData() *types.CommonEntityData

type Suppression_RuleDetails 

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

	// Details of one of the suppression rules. The type is slice of
	// Suppression_RuleDetails_RuleDetail.
	RuleDetail []*Suppression_RuleDetails_RuleDetail
}

Suppression_RuleDetails Table that contains the database of suppression rule details

func (*Suppression_RuleDetails) GetEntityData 

func (ruleDetails *Suppression_RuleDetails) GetEntityData() *types.CommonEntityData

type Suppression_RuleDetails_RuleDetail 

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

	// This attribute is a key. Suppression Rule Name. The type is string with
	// length: 1..32.
	RuleName interface{}

	// Match any alarm. The type is bool.
	AllAlarms interface{}

	// Severity level to suppress. The type is AlAlarmSeverity.
	AlarmSeverity interface{}

	// Sources (R/S/M) to which the rule is applied. The type is slice of string
	// with pattern: ([a-zA-Z0-9_]*\d+/){1,2}([a-zA-Z0-9_]*\d+).
	ApplySource []interface{}

	// Rule summary, name, etc.
	RuleSummary Suppression_RuleDetails_RuleDetail_RuleSummary

	// Message codes defining the rule. The type is slice of
	// Suppression_RuleDetails_RuleDetail_Codes.
	Codes []*Suppression_RuleDetails_RuleDetail_Codes
}

Suppression_RuleDetails_RuleDetail Details of one of the suppression rules

func (*Suppression_RuleDetails_RuleDetail) GetEntityData 

func (ruleDetail *Suppression_RuleDetails_RuleDetail) GetEntityData() *types.CommonEntityData

type Suppression_RuleDetails_RuleDetail_Codes 

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

	// Category of messages to which this alarm belongs. The type is string.
	Category interface{}

	// Group of messages to which this alarm belongs. The type is string.
	Group interface{}

	// Alarm code which further qualifies the alarm within a message group. The
	// type is string.
	Code interface{}
}

Suppression_RuleDetails_RuleDetail_Codes Message codes defining the rule.

func (*Suppression_RuleDetails_RuleDetail_Codes) GetEntityData 

func (codes *Suppression_RuleDetails_RuleDetail_Codes) GetEntityData() *types.CommonEntityData

type Suppression_RuleDetails_RuleDetail_RuleSummary 

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

	// Suppress Rule Name. The type is string.
	RuleNameXr interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Number of suppressed alarms associated with this rule. The type is
	// interface{} with range: 0..4294967295.
	SuppressedAlarmsCount interface{}
}

Suppression_RuleDetails_RuleDetail_RuleSummary Rule summary, name, etc

func (*Suppression_RuleDetails_RuleDetail_RuleSummary) GetEntityData 

func (ruleSummary *Suppression_RuleDetails_RuleDetail_RuleSummary) GetEntityData() *types.CommonEntityData

type Suppression_RuleSummaries 

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

	// One of the suppression rules. The type is slice of
	// Suppression_RuleSummaries_RuleSummary.
	RuleSummary []*Suppression_RuleSummaries_RuleSummary
}

Suppression_RuleSummaries Table that contains the database of suppression rule summary

func (*Suppression_RuleSummaries) GetEntityData 

func (ruleSummaries *Suppression_RuleSummaries) GetEntityData() *types.CommonEntityData

type Suppression_RuleSummaries_RuleSummary 

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

	// This attribute is a key. Suppression Rule Name. The type is string with
	// length: 1..32.
	RuleName interface{}

	// Suppress Rule Name. The type is string.
	RuleNameXr interface{}

	// Applied state of the rule It could be not applied, applied or applied to
	// all. The type is AcRuleState.
	RuleState interface{}

	// Number of suppressed alarms associated with this rule. The type is
	// interface{} with range: 0..4294967295.
	SuppressedAlarmsCount interface{}
}

Suppression_RuleSummaries_RuleSummary One of the suppression rules

func (*Suppression_RuleSummaries_RuleSummary) GetEntityData 

func (ruleSummary *Suppression_RuleSummaries_RuleSummary) GetEntityData() *types.CommonEntityData

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.