cisco_ip_local_pool_mib

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 MIB defines the configuration and monitoring capabilities relating to local IP pools.

Local IP pools have the following characteristics:

- An IP local pool consists of one or more IP address ranges.

- An IP pool group consists of one or more IP local pools.

- An IP local pool can only belong to one IP pool group.

  • IP local pools that belong to different groups can have overlapping addresses.
  • IP local pool names are unique even when they belong to different groups.

- Addresses within an IP pool group can not overlap.

  • IP local pools without an explicit group name are considered members of the base system group. In this MIB, the base system group is represented by a null IP pool group name.

This MIB defines objects that expose the relationship between IP pool groups and IP local pools. There exist other objects that maintain statistics about the address usage of IP local pools.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCOIPLOCALPOOLMIB 

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

	CIpLocalPoolConfig CISCOIPLOCALPOOLMIB_CIpLocalPoolConfig

	// This table manages the creation, modification, and deletion of IP local
	// pools using the RowStatus textual convention.  An entry in this table
	// defines an IP address range that is associated with an IP local pool.  A
	// conceptual row in this table can not be modified while
	// cIpLocalPoolRowStatus is set to 'active'.  Since IP local pool names are
	// unique even when they belong to different groups, and addresses within a
	// group can not overlap, a row in this table is uniquely indexed by the pool
	// name, and by the low address of the IP local pool together with its address
	// type.
	CIpLocalPoolConfigTable CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable

	// A table which exposes the container/'containee' relationships between local
	// IP pools and IP pool groups.  Entries in this table are created or deleted
	// as a by-product of creating or deleting entries in the
	// cIpLocalPoolConfigTable.  When an entry is created and activated in the
	// cIpLocalPoolConfigTable table, an entry in this table will come into
	// existence if it does not already exist.  When an entry is deleted in the
	// cIpLocalPoolConfigTable table, if there is no other entry existing in that
	// table with the same cIpLocalPoolGroupContainedIn and cIpLocalPoolName, the
	// entry in this table with the respective cIpLocalPoolGroupName and
	// cIpLocalPoolName indices will be removed.
	CIpLocalPoolGroupContainsTable CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable

	// This table provides statistics for configured IP pool groups.  Entries in
	// this table are created as the result of adding a new IP pool group to the
	// cIpLocalPoolConfigTable.  Entries in this table are deleted as the result
	// of removing all IP local pools that are contained in an IP pool group in
	// the cIpLocalPoolConfigTable.  An entry in this table is uniquely indexed by
	// IP pool group name.
	CIpLocalPoolGroupTable CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable

	// A table providing statistics for each IP local pool.  Entries in this table
	// are created as the result of adding a new IP local pool to the
	// cIpLocalPoolConfigTable.  Entries in this table are deleted as the result
	// of removing all the address ranges that are contained in an IP local pool
	// in the cIpLocalPoolConfigTable.  Entries in this table are uniquely indexed
	// by the name of the IP local pool.
	CIpLocalPoolStatsTable CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable

	// This table lists all addresses that have been allocated out of an IP local
	// pool.  Entries in this table are created when a remote peer allocates an
	// address from one of the IP local pools in the cIpLocalPoolConfigTable.
	// Entries in this table are deleted when a remote peer deallocates an address
	// from one of the IP local pool in the cIpLocalPoolConfigTable.  Entries in
	// this table are uniquely indexed by the name of the IP local pool, and the
	// allocated address, together with its address type.
	CIpLocalPoolAllocTable CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable
}

CISCOIPLOCALPOOLMIB

func (*CISCOIPLOCALPOOLMIB) GetEntityData 

func (cISCOIPLOCALPOOLMIB *CISCOIPLOCALPOOLMIB) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable 

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

	// Each entry refers to conceptual row that associates an IP addresses with
	// the interface where the request was received, and the user that requested
	// the address. The type is slice of
	// CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry.
	CIpLocalPoolAllocEntry []*CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable This table lists all addresses that have been allocated out of an IP local pool.

Entries in this table are created when a remote peer allocates an address from one of the IP local pools in the cIpLocalPoolConfigTable.

Entries in this table are deleted when a remote peer deallocates an address from one of the IP local pool in the cIpLocalPoolConfigTable.

Entries in this table are uniquely indexed by the name of the IP local pool, and the allocated address, together with its address type.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable) GetEntityData 

func (cIpLocalPoolAllocTable *CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry 

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

	// This attribute is a key. The type is string with length: 1..48. Refers to
	// cisco_ip_local_pool_mib.CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry_CIpLocalPoolName
	CIpLocalPoolName interface{}

	// This attribute is a key. This object specifies the address type of
	// cIpLocalPoolAllocAddr. The type is InetAddressType.
	CIpLocalPoolAllocAddrType interface{}

	// This attribute is a key. This object specifies the allocated IP address.
	// The address type of this object is described by cIpLocalPoolAllocAddrType.
	// The type is string with length: 0..255.
	CIpLocalPoolAllocAddr interface{}

	// This object indicates the interface from which the allocation message was
	// sent.  In the case that the interface can not be determined, the value of
	// this object will be zero. The type is interface{} with range:
	// 0..2147483647.
	CIpLocalPoolAllocIfIndex interface{}

	// This object indicates the user name of the person from whom the allocation
	// message was sent.  In the case that the user name can not be determined,
	// the value of this object will the null string. The type is string.
	CIpLocalPoolAllocUser interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry Each entry refers to conceptual row that associates an IP addresses with the interface where the request was received, and the user that requested the address.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry) GetEntityData 

func (cIpLocalPoolAllocEntry *CISCOIPLOCALPOOLMIB_CIpLocalPoolAllocTable_CIpLocalPoolAllocEntry) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolConfig 

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

	// An indication of whether the notifications defined by the
	// ciscoIpLocalPoolNotifGroup are enabled. The type is bool.
	CIpLocalPoolNotificationsEnable interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolConfig

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolConfig) GetEntityData 

func (cIpLocalPoolConfig *CISCOIPLOCALPOOLMIB_CIpLocalPoolConfig) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable 

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

	// Each entry provides information about a particular IP local pool, including
	// the number of free and used addresses and its priority. The type is slice
	// of CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry.
	CIpLocalPoolConfigEntry []*CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable This table manages the creation, modification, and deletion of IP local pools using the RowStatus textual convention. An entry in this table defines an IP address range that is associated with an IP local pool.

A conceptual row in this table can not be modified while cIpLocalPoolRowStatus is set to 'active'.

Since IP local pool names are unique even when they belong to different groups, and addresses within a group can not overlap, a row in this table is uniquely indexed by the pool name, and by the low address of the IP local pool together with its address type.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable) GetEntityData 

func (cIpLocalPoolConfigTable *CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry 

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

	// This attribute is a key. An arbitrary non-empty string that uniquely
	// identifies the IP local pool.  This name must be unique among all the local
	// IP pools even when they belong to different pool groups. The type is string
	// with length: 1..48.
	CIpLocalPoolName interface{}

	// This attribute is a key. This object specifies the address type of
	// cIpLocalPoolAddressLo and cIpLocalPoolAddressHi. The type is
	// InetAddressType.
	CIpLocalPoolAddrType interface{}

	// This attribute is a key. This object specifies the first IP address of the
	// range of IP addresses contained by this pool entry.  The address type of
	// this object is described by cIpLocalPoolAddrType.  This address must be
	// less than or equal to the address in cIpLocalPoolAddressHi. The type is
	// string with length: 0..255.
	CIpLocalPoolAddressLo interface{}

	// This object specifies the last IP address of the range of IP addresses
	// mapped by this pool entry.  The address type of this object is described by
	// cIpLocalPoolAddrType.  If only a single address is being mapped, the value
	// of this object is equal to the value of cIpLocalPoolAddressLo. The type is
	// string with length: 0..255.
	CIpLocalPoolAddressHi interface{}

	// The number of IP addresses available for use in the range of IP addresses.
	// The type is interface{} with range: 0..4294967295.
	CIpLocalPoolFreeAddrs interface{}

	// The number of IP addresses being used in the range of IP addresses. The
	// type is interface{} with range: 0..4294967295.
	CIpLocalPoolInUseAddrs interface{}

	// This object relates an IP local pool to its IP pool group.  A null string
	// indicates this IP local pool is not contained in a named IP pool group, but
	// that it is contained in the base IP pool group.  An IP local pool can only
	// belong to one IP pool group. The type is string with length: 0..48.
	CIpLocalPoolGroupContainedIn interface{}

	// This object facilitates the creation, or deletion of a conceptual row in
	// this table. The type is RowStatus.
	CIpLocalPoolRowStatus interface{}

	// This object specifies priority of the IP local pool, where smaller value
	// indicates the lower priority. The priority value is used in assigning IP
	// Address  from local pools. The type is interface{} with range: 1..255.
	CIpLocalPoolPriority interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry Each entry provides information about a particular IP local pool, including the number of free and used addresses and its priority.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry) GetEntityData 

func (cIpLocalPoolConfigEntry *CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable 

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

	// Each entry describes single container/'containee' relationship.  Pool names
	// can only be associated with one group.  Pools carry implicit group
	// identifiers because pool names can only be associated with one group.  An
	// entry in this table describes such an association. The type is slice of
	// CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry.
	CIpLocalPoolGroupContainsEntry []*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable A table which exposes the container/'containee' relationships between local IP pools and IP pool groups.

Entries in this table are created or deleted as a by-product of creating or deleting entries in the cIpLocalPoolConfigTable.

When an entry is created and activated in the cIpLocalPoolConfigTable table, an entry in this table will come into existence if it does not already exist.

When an entry is deleted in the cIpLocalPoolConfigTable table, if there is no other entry existing in that table with the same cIpLocalPoolGroupContainedIn and cIpLocalPoolName, the entry in this table with the respective cIpLocalPoolGroupName and cIpLocalPoolName indices will be removed.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable) GetEntityData 

func (cIpLocalPoolGroupContainsTable *CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry 

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

	// This attribute is a key. A unique group name that identifies the IP pool
	// group.  The null string represents the base IP pool group. The type is
	// string with length: 0..48.
	CIpLocalPoolGroupName interface{}

	// This attribute is a key. The value of cIpLocalPoolName for the contained IP
	// local pool. The type is string with length: 1..48.
	CIpLocalPoolChildIndex interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry Each entry describes single container/'containee' relationship.

Pool names can only be associated with one group. Pools carry implicit group identifiers because pool names can only be associated with one group. An entry in this table describes such an association.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry) GetEntityData 

func (cIpLocalPoolGroupContainsEntry *CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable 

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

	// Each entry provides information about a particular IP pool group and the
	// number of free and used addresses in an IP pool group. The type is slice of
	// CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry.
	CIpLocalPoolGroupEntry []*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable This table provides statistics for configured IP pool groups.

Entries in this table are created as the result of adding a new IP pool group to the cIpLocalPoolConfigTable.

Entries in this table are deleted as the result of removing all IP local pools that are contained in an IP pool group in the cIpLocalPoolConfigTable.

An entry in this table is uniquely indexed by IP pool group name.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable) GetEntityData 

func (cIpLocalPoolGroupTable *CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry 

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

	// This attribute is a key. The type is string with length: 0..48. Refers to
	// cisco_ip_local_pool_mib.CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupContainsTable_CIpLocalPoolGroupContainsEntry_CIpLocalPoolGroupName
	CIpLocalPoolGroupName interface{}

	// The number of IP addresses available for use in the IP pool group. The type
	// is interface{} with range: 0..4294967295.
	CIpLocalPoolGroupFreeAddrs interface{}

	// The number of IP addresses that have been allocated from the IP pool group.
	// The type is interface{} with range: 0..4294967295.
	CIpLocalPoolGroupInUseAddrs interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry Each entry provides information about a particular IP pool group and the number of free and used addresses in an IP pool group.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry) GetEntityData 

func (cIpLocalPoolGroupEntry *CISCOIPLOCALPOOLMIB_CIpLocalPoolGroupTable_CIpLocalPoolGroupEntry) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable 

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

	// Each entry provides statistical information about a particular IP local
	// pool, and the total number of free and used addresses of all the ranges in
	// an IP local pool. The type is slice of
	// CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry.
	CIpLocalPoolStatsEntry []*CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable A table providing statistics for each IP local pool.

Entries in this table are created as the result of adding a new IP local pool to the cIpLocalPoolConfigTable.

Entries in this table are deleted as the result of removing all the address ranges that are contained in an IP local pool in the cIpLocalPoolConfigTable.

Entries in this table are uniquely indexed by the name of the IP local pool.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable) GetEntityData 

func (cIpLocalPoolStatsTable *CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable) GetEntityData() *types.CommonEntityData

type CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry 

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

	// This attribute is a key. The type is string with length: 1..48. Refers to
	// cisco_ip_local_pool_mib.CISCOIPLOCALPOOLMIB_CIpLocalPoolConfigTable_CIpLocalPoolConfigEntry_CIpLocalPoolName
	CIpLocalPoolName interface{}

	// The number of IP addresses available for use in this IP local pool. The
	// type is interface{} with range: 0..4294967295.
	CIpLocalPoolStatFreeAddrs interface{}

	// The number of IP addresses being used in this IP local pool. The type is
	// interface{} with range: 0..4294967295.
	CIpLocalPoolStatInUseAddrs interface{}

	// This object contains the high water mark of used addresses in an IP local
	// pool since pool creation, since the system was restarted, or since this
	// object was reset, whichever occurred last.  This object can only be set to
	// zero, and by doing so, it is reset to the value of
	// cIpLocalPoolStatInUseAddrs.  Since the number of addresses in a pool can be
	// reduced (e.g. by deleting one of its ranges), the value of this object may
	// be greater than the sum of cIpLocalPoolStatFreeAddrs and
	// cIpLocalPoolStatInUseAddrs. The type is interface{} with range:
	// 0..4294967295.
	CIpLocalPoolStatHiWaterUsedAddrs interface{}

	// When the number of used addresses in an IP local pool falls below this
	// threshold value, the ciscoIpLocalPoolInUseAddrNoti notification will be
	// rearmed.  The value of this object should never be greater than the value
	// of cIpLocalPoolStatInUseAddrThldHi. The type is interface{} with range:
	// 0..4294967295.
	CIpLocalPoolStatInUseAddrThldLo interface{}

	// When the number of used addresses in an IP local pool is equal or exceeds
	// this threshold value, a ciscoIpLocalPoolInUseAddrNoti notification will be
	// generated. Once this notification is generated, it will be disarmed and it
	// will not be generated again until the number of used address falls below
	// the value indicated by cIpLocalPoolStatInUseAddrThldLo.  The value of this
	// object should never be smaller than the value of
	// cIpLocalPoolStatInUseAddrThldLo. The type is interface{} with range:
	// 0..4294967295.
	CIpLocalPoolStatInUseAddrThldHi interface{}

	// When the percentage of used addresses in an IP local pool falls below this
	// threshold value, a cilpPercentAddrUsedLoNotif notification will be
	// generated.  Once the notification is generated, it will be disarmed and it
	// will not be generated again until the number of used addresses equals or
	// exceeds the value indicated by cIpLocalPoolPercentAddrThldHi.  The value of
	// this object should never be greater than the value of
	// cIpLocalPoolPercentAddrThldHi. The type is interface{} with range: 0..100.
	CIpLocalPoolPercentAddrThldLo interface{}

	// When the percentage of used addresses in an IP local pool is equal or
	// exceeds this threshold value, a cilpPercentAddrUsedHiNotif notification
	// will be generated. Once the notification is generated, it will be disarmed
	// and it will not be generated again until the number of used addresses falls
	// below the value indicated by cIpLocalPoolPercentAddrThldLo.  The value of
	// this object should never be smaller than the value of
	// cIpLocalPoolPercentAddrThldLo. The type is interface{} with range: 0..100.
	CIpLocalPoolPercentAddrThldHi interface{}
}

CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry Each entry provides statistical information about a particular IP local pool, and the total number of free and used addresses of all the ranges in an IP local pool.

func (*CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry) GetEntityData 

func (cIpLocalPoolStatsEntry *CISCOIPLOCALPOOLMIB_CIpLocalPoolStatsTable_CIpLocalPoolStatsEntry) 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.