cisco_igmp_filter_mib

package
v0.0.0-...-fac1166 Latest Latest
Warning

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

 Go to latest Published: Oct 17, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

IGMP Filter configuration MIB. This MIB provides a mechanism for users to configure the system to intercept IGMP joins for IP Multicast groups identified in this MIB and only allow certain ports to join certain multicast groups.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCOIGMPFILTERMIB 

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

	CIgmpFilterGeneral CISCOIGMPFILTERMIB_CIgmpFilterGeneral

	CIgmpFilterEditor CISCOIGMPFILTERMIB_CIgmpFilterEditor

	// This table contains entries that identify lists of IP Multicast groups for
	// each profile configured on the device.   Each entry contains a range of
	// contiguous IP Multicast groups associated to a profile index. Multiple
	// cIgmpFilterEntry may be associated with the same cIgmpFilterProfileIndex.
	// All the cIgmpFilterEntry with  the same profile index  are subjected to the
	// same IGMP filtering action as  defined in cIgmpFilterProfileAction.  Each
	// profile index may be associated with zero or more  interfaces through
	// cIgmpFilterInterfaceIfIndex object in cIgmpFilterInterfaceTable. The
	// maximum number of entries is determined by cIgmpFilterMaxProfiles.
	CIgmpFilterTable CISCOIGMPFILTERMIB_CIgmpFilterTable

	// This table contains the list of interfaces that can support IGMP filter
	// feature.
	CIgmpFilterInterfaceTable CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable
}

CISCOIGMPFILTERMIB

func (*CISCOIGMPFILTERMIB) GetEntityData 

func (cISCOIGMPFILTERMIB *CISCOIGMPFILTERMIB) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterEditor 

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

	// This object is used to facilitate modification of IGMP Filter Editor Group
	// in the CISCO-IGMP-FILTER-MIB  module by multiple managers.  In particular,
	// it is  useful when modifying the value of the cIgmpFilterEditor  object.
	// The procedure for modifying the cIgmpFilterEditor  object is as follows:
	// 1.  Retrieve the value of cIgmpFilterEditSpinLock and          of object
	// within cIgmpFilterEditor group.       2.  Generate new values for
	// 'writeable' objects         in the cIgmpFilterEditor group except for
	// cIgmpFilterEditSpinLock object.      3.  Set the value of
	// cIgmpFilterEditSpinLock to the          retrieved value, and the value of
	// objects in          cIgmpFilterEditor to the new value. If the set
	// fails for the cIgmpFilterEditSpinLock object,         go back to step 1.
	// The cIgmpFilterApplyStatus and cIgmpFilterEditSpinLock  should be read
	// together by NMS to make sure that the  result is associated with its
	// configuration request.  To add/delete or modify a profile ( through
	// cIgmpFilterEditor objects ) following procedure may be followed as an
	// example.:      1.  GET(cIgmpFilterEditSpinLock.0) and save in sValue.
	// 2.  SET(cIgmpFilterEditSpinLock.0 = sValue,
	// cIgmpFilterEditProfileIndex.0 = validProfileNumber,
	// cIgmpFilterEditStartAddress.0 = validStartAddress,
	// cIgmpFilterEditEndAddress.0 = validEndAddress,
	// cIgmpFilterEditOperation.0 =  validOperation)     3.  If the SET in step 2
	// is not successful go back         to step 1.     4.  If the SET in step 2
	// is successful, user should          GET(cIgmpFilterEditSpinLock.0) and
	// GET(cIgmpFilterApplyStatus.0) simultaneously.      5.  The
	// cIgmpFilterApplyStatus.0 reflects the outcome of         step 2 only if
	// cIgmpFilterEditSpinLock.0 = sValue + 1 or         cIgmpFilterEditSpinLock.0
	// = 0 if sValue reaches         value at which cIgmpFilterEditSpinLock wraps
	// around. The type is interface{} with range: 0..2147483647.
	CIgmpFilterEditSpinLock interface{}

	// Buffer object to edit corresponding object cIgmpFilterProfileIndex in
	// cIgmpFilterTable.  Maximum value this object can be set to is  determined
	// by cIgmpFilterMaxProfiles object. The type is interface{} with range:
	// 0..4294967295.
	CIgmpFilterEditProfileIndex interface{}

	// Buffer object to edit corresponding object cIgmpFilterStartAddressType in
	// cIgmpFilterTable.  This object describes the type of Internet   address
	// used to determine the start address  of IP multicast group for a profile.
	// The type is InetAddressType.
	CIgmpFilterEditStartAddressType interface{}

	// Buffer object to edit corresponding object cIgmpFilterStartAddress in
	// cIgmpFilterTable   to establish start address of filtering range for a
	// profile. The type is string with length: 1..64.
	CIgmpFilterEditStartAddress interface{}

	// Buffer object to edit corresponding object cIgmpFilterEndAddressType in
	// cIgmpFilterTable.  This object describes the type of Internet      address
	// used to determine the start address  of IP multicast group for a profile.
	// The type is InetAddressType.
	CIgmpFilterEditEndAddressType interface{}

	// Buffer object to edit corresponding object cIgmpFilterEndAddress in
	// cIgmpFilterTable  to establish end address of filtering  range for a
	// profile. The type is string with length: 0..255.
	CIgmpFilterEditEndAddress interface{}

	// Buffer object to edit corresponding object in cIgmpFilterTable to determine
	// filtering action of each profile. The type is CIgmpFilterEditProfileAction.
	CIgmpFilterEditProfileAction interface{}

	// The function of this object is to allow user to apply the changes in
	// cIgmpFilterEditor objects to  cIgmpFilterTable.   This object always has
	// the value 'none' when read. When written each value causes the appropriate
	// action:  'add' - tries to insert the information contained  in
	// cIgmpFilterEditor objects into  cIgmpFilterTable. If the entry already
	// exists in the table the 'add'  fails.          'delete' - tries to delete
	// corresponding entry from cIgmpFilterTable. If a user completely deletes a
	// profile that has corresponding entries in the cIgmpFilterInterfaceTable,
	// then all the interfaces mapped to corresponding profile will be cleared and
	// set to zero.  'modify' - Mode of operation used to edit an entry in
	// cIgmpFilterTable. If the corresponding entry does not   exist, modify
	// operation fails. This mode allows user to  extend/truncate a contiguous
	// filtered range, type of  Internet addressing and filtering action for a
	// profile.   'none' - no operation is performed. The type is
	// CIgmpFilterEditOperation.
	CIgmpFilterEditOperation interface{}

	// The current status of an 'add', 'delete' or 'modify' operation. If no apply
	// is currently active, the status  represented is that of the most recently
	// completed 'add',  'delete' or 'modify' operation.  The value of this
	// objects indicates succeeded(2) state  initially when no 'add', 'delete',
	// 'modify' operation has been carried out.  The possible values are:
	// someOtherError - the 'add', 'delete' or 'modify' failed     due to
	// undefined error(s) in apply operation.    (e.g., insufficient memory).
	// succeeded - the 'add', 'delete' or 'modify' operation    was successful.
	// (This value is also used when no    apply has been invoked since the last
	// time the local     system restarted.)     inconsistentEdit - the 'add',
	// 'delete' or 'modify' failed    due to inconsistency of the data.
	// entryPresentError - the 'add' operation failed  as the     corresponding
	// entry already exists in cIgmpFilterTable.     entryNotPresentError - the
	// 'modify' operation failed     as no corresponding entry exists in
	// cIgmpFilterTable. The type is CIgmpFilterApplyStatus.
	CIgmpFilterApplyStatus interface{}
}

CISCOIGMPFILTERMIB_CIgmpFilterEditor

func (*CISCOIGMPFILTERMIB_CIgmpFilterEditor) GetEntityData 

func (cIgmpFilterEditor *CISCOIGMPFILTERMIB_CIgmpFilterEditor) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus 

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus string

CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus represents as no corresponding entry exists in cIgmpFilterTable. 

const (
	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus_someOtherError CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus = "someOtherError"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus_succeeded CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus = "succeeded"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus_inconsistentEdit CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus = "inconsistentEdit"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus_entryPresentError CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus = "entryPresentError"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus_entryNotPresentError CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterApplyStatus = "entryNotPresentError"
)

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation 

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation string

CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation represents 'none' - no operation is performed. 

const (
	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation_none CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation = "none"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation_add CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation = "add"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation_delete_ CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation = "delete"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation_modify CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditOperation = "modify"
)

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction 

type CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction string

CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction represents of each profile. 

const (
	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction_unSpecified CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction = "unSpecified"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction_permit CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction = "permit"

	CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction_deny CISCOIGMPFILTERMIB_CIgmpFilterEditor_CIgmpFilterEditProfileAction = "deny"
)

type CISCOIGMPFILTERMIB_CIgmpFilterGeneral 

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

	// This object controls whether the IGMP filtering is enabled on the device. A
	// false(2) value will  prevent the IGMP filtering action on the device. The
	// type is bool.
	CIgmpFilterEnable interface{}

	// Indicates the maximum number of profiles supported by this device.  A value
	// of zero indicates no limitation on the number of profiles. The type is
	// interface{} with range: 0..4294967295. Units are profiles.
	CIgmpFilterMaxProfiles interface{}
}

CISCOIGMPFILTERMIB_CIgmpFilterGeneral

func (*CISCOIGMPFILTERMIB_CIgmpFilterGeneral) GetEntityData 

func (cIgmpFilterGeneral *CISCOIGMPFILTERMIB_CIgmpFilterGeneral) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable 

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

	// Each entry contains the configuration for associating the IGMP filter
	// profile index with the interface.  An entry is created for each of the IGMP
	// filter capable  interface on the system.  The entry is removed on removal
	// of corresponding  interface from system. The type is slice of
	// CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry.
	CIgmpFilterInterfaceEntry []*CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry
}

CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable This table contains the list of interfaces that can support IGMP filter feature.

func (*CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable) GetEntityData 

func (cIgmpFilterInterfaceTable *CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry 

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

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// Specifies which IGMP filter profile applies to this interface. If the value
	// of this MIB object matches the  value of cIgmpFilterProfileIndex in
	// cIgmpFilterTable,  the corresponding profile configuration will apply to
	// this interface.   Agent returns inconsistentValue if this profile  does not
	// exist in cIgmpFilterTable.  A value of zero indicates no profile is
	// associated with corresponding interface.  The filtering action on each
	// interface is also defined by the associated profile. The type is
	// interface{} with range: 0..4294967295.
	CIgmpFilterInterfaceProfileIndex interface{}
}

CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry Each entry contains the configuration for associating the IGMP filter profile index with the interface.

An entry is created for each of the IGMP filter capable interface on the system.

The entry is removed on removal of corresponding interface from system.

func (*CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry) GetEntityData 

func (cIgmpFilterInterfaceEntry *CISCOIGMPFILTERMIB_CIgmpFilterInterfaceTable_CIgmpFilterInterfaceEntry) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterTable 

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

	// An entry (conceptual row) in the cIgmpFilterTable.  The creation, deletion
	// or modification of an entry is controlled through the MIB objects defined
	// under cIgmpFilterEditor group. The type is slice of
	// CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry.
	CIgmpFilterEntry []*CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry
}

CISCOIGMPFILTERMIB_CIgmpFilterTable This table contains entries that identify lists of IP Multicast groups for each profile configured on the device.

Each entry contains a range of contiguous IP Multicast groups associated to a profile index. Multiple cIgmpFilterEntry may be associated with the same cIgmpFilterProfileIndex.

All the cIgmpFilterEntry with the same profile index are subjected to the same IGMP filtering action as defined in cIgmpFilterProfileAction.

Each profile index may be associated with zero or more interfaces through cIgmpFilterInterfaceIfIndex object in cIgmpFilterInterfaceTable. The maximum number of entries is determined by cIgmpFilterMaxProfiles.

func (*CISCOIGMPFILTERMIB_CIgmpFilterTable) GetEntityData 

func (cIgmpFilterTable *CISCOIGMPFILTERMIB_CIgmpFilterTable) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry 

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

	// This attribute is a key. Index identifying this entry. The type is
	// interface{} with range: 0..4294967295.
	CIgmpFilterProfileIndex interface{}

	// This attribute is a key. This object describes the type of Internet address
	// used to determine the start address  of IP multicast group for a profile.
	// The type is InetAddressType.
	CIgmpFilterStartAddressType interface{}

	// This attribute is a key. This object describes the start of the IP
	// multicast group address of a contiguous range which will be subjected to
	// filtering operation. The type is string with length: 1..64.
	CIgmpFilterStartAddress interface{}

	// This object indicates the type of Internet address used to determine the
	// end address  of IP multicast group for a profile. The type is
	// InetAddressType.
	CIgmpFilterEndAddressType interface{}

	// This object indicates the end of the IP multicast group address of a
	// contiguous range which will be  subjected to filtering operation. The type
	// is string with length: 0..255.
	CIgmpFilterEndAddress interface{}

	// This object defines the action for filtering IGMP reports for this profile.
	// If the object is set to deny(2): then all IGMP reports associated to IP
	// multicast groups included in the profile identified by
	// cIgmpFilterInterfaceProfileIndex will be dropped.  If the object is set to
	// permit(1): then all IGMP reports associated to IP multicast groups not
	// included in the profile identified by cIgmpFilterInterfaceProfileIndex will
	// be dropped. The type is CIgmpFilterProfileAction.
	CIgmpFilterProfileAction interface{}
}

CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry An entry (conceptual row) in the cIgmpFilterTable.

The creation, deletion or modification of an entry is controlled through the MIB objects defined under cIgmpFilterEditor group.

func (*CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry) GetEntityData 

func (cIgmpFilterEntry *CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry) GetEntityData() *types.CommonEntityData

type CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction 

type CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction string

CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction represents cIgmpFilterInterfaceProfileIndex will be dropped. 

const (
	CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction_permit CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction = "permit"

	CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction_deny CISCOIGMPFILTERMIB_CIgmpFilterTable_CIgmpFilterEntry_CIgmpFilterProfileAction = "deny"
)

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.