cisco_image_license_mgmt_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

The MIB module for managing the running image level of a Cisco device. Cisco's licensing mechanism provides flexibility to run a device on a chosen image level. This mechanism is referred to as image level licensing. Image level licensing leverages the universal image based licensing solution.

The image level licensing mechanism works as follows -

A universal image that contains all levels of software packages is loaded on to the device. At boot time, the device determines the highest level of license and brings up the appropriate software features or subsystems. The user can configure the image level with which the device has to boot. The system will verify whether the appropriate license is available for the configured image level. The image level for the next boot will be determined based on the availability of the license. The following scenarios explains some use-cases of image level licensing:

Scenario 1: - Customer selects advsecurityk9 based image. - Manufacturing installs advsecurity license on the device. - This device will run all features that are part of the base advsecurity license. - Customer upgrades to advipservicesk9 license. - The next boot level is set to advipservicesk9. - The device will run advsecurityk9 feature until the next reboot. After reboot the device will run advipservicesk9 features.

Scenario 2: - Customer selects advipservicesk9 based image. - Manufacturing installs advipservices and advsecurity license on the device. - This device will run all features that are part of the base advipservices license. - No upgrades available for advipservices license.

The user has to accept the End User License Agreement(EULA) before using this MIB to configure the image level.

This MIB should be used in conjuntion with CISCO-LICENSE-MGMT-MIB module to achieve the image level licensing functionality.

This MIB module defines objects which provides the different image levels supported by the device and the license required to enable a particular image level. It also defines objects to let the user configure the required image level. The MIB module contains notification which will be triggered when the user changes the image level for next boot.

The CISCO-LICENSE-MGMT-MIB module should be used to export the EULA and to configure the required license.

This MIB module is defined generically so it can be used for both stand-alone as well as stackable devices. The entPhysicalIndex imported from ENTITY-MIB is used to identify the device uniquely.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CISCOIMAGELICENSEMGMTMIB 

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

	CiscoImageLicenseMgmtMIBObjects CISCOIMAGELICENSEMGMTMIB_CiscoImageLicenseMgmtMIBObjects

	CilmNotifCntl CISCOIMAGELICENSEMGMTMIB_CilmNotifCntl

	// A table that contains the configuration information of current and next
	// boot image level. This table contains entries for each software module
	// running in an image  loaded in the device. The software module is
	// identified by cilmModuleName and the device is identified by
	// entPhysicalIndex.
	CilmBootImageLevelTable CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable

	// This table contains the mapping between different image levels of each
	// modules in the image and the license required to run the modules at a
	// particular image level. This table can be used to identify the different
	// image levels and the appropriate licenses  required for each.
	CilmImageLevelToLicenseMapTable CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable
}

CISCOIMAGELICENSEMGMTMIB

func (*CISCOIMAGELICENSEMGMTMIB) GetEntityData 

func (cISCOIMAGELICENSEMGMTMIB *CISCOIMAGELICENSEMGMTMIB) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable 

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

	// An entry in the table for each module containing the list of objects that
	// define the configuration of next boot level. The following information is
	// specified by the objects present in the table.  - Current image level. -
	// Configured image level for the next boot. - Actual image level for the next
	// boot. - License store index for the current license. - License index of the
	// current license. - License store index for the next boot license. - License
	// index of the next boot license. The type is slice of
	// CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry.
	CilmBootImageLevelEntry []*CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry
}

CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable A table that contains the configuration information of current and next boot image level. This table contains entries for each software module running in an image loaded in the device. The software module is identified by cilmModuleName and the device is identified by entPhysicalIndex.

func (*CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable) GetEntityData 

func (cilmBootImageLevelTable *CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry 

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

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to
	// entity_mib.ENTITYMIB_EntPhysicalTable_EntPhysicalEntry_EntPhysicalIndex
	EntPhysicalIndex interface{}

	// This attribute is a key. This object is used as one of the two indices in
	// cilmBootImageLevelTable. This object indicates the module name of the
	// software package. There can be multiple modules in an image performing
	// specific functionality. For example, in a wireless image there can be two
	// modules - a base image module and a wireless module. The type is string.
	CilmModuleName interface{}

	// This object indicates the current image level that the module is running.
	// The type is string with length: 0..255.
	CilmCurrentImageLevel interface{}

	// This object indicates the configured image level of the module for the next
	// boot.  Note: The configured next boot image level may not  be the actual
	// next boot image level. The actual next boot image level is denoted by
	// cilmNextBootImageLevel which is determined based on the license
	// availability. The type is string with length: 0..255.
	CilmConfiguredBootImageLevel interface{}

	// This object indicates the next boot image level. The next boot image level
	// can be different from configured level. The next boot image level is
	// determined based on the availability of required license. The type is
	// string with length: 0..255.
	CilmNextBootImageLevel interface{}

	// This object indicates the license store index where the currently used
	// license is stored. This object has the same value as
	// clmgmtLicenseStoreIndex object and uniquely identifies an entry in
	// clmgmtLicenseStoreInfoTable in CISCO-LICENSE-MGMT-MIB.  Note: The license
	// store index can be '0' if no license is installed and device is running
	// base image. The type is interface{} with range: 0..4294967295.
	CilmCurrentLicenseStoreIndex interface{}

	// This object indicates the license index of the currently used license. This
	// object has the same value as clmgmtLicenseIndex and uniquely identifies an
	// entry in clmgmtLicenseInfoTable in CISCO-LICENSE-MGMT-MIB.  Note: The
	// license index can be '0' if no license is installed and device is running
	// base image. The type is interface{} with range: 0..4294967295.
	CilmCurrentLicenseIndex interface{}

	// This object indicates the license store index where the next boot license
	// is stored. This object has the same value as clmgmtLicenseStoreIndex object
	// and uniquely identifies an entry in clmgmtLicenseStoreInfoTable in
	// CISCO-LICENSE-MGMT-MIB.  Note: The license store index can be '0' if no
	// license is installed for the next boot. The type is interface{} with range:
	// 0..4294967295.
	CilmNextBootLicenseStoreIndex interface{}

	// This object indicates the license index of the next boot license. This
	// object has the same value as clmgmtLicenseIndex and uniquely identifies an
	// entry in clmgmtLicenseInfoTable in CISCO-LICENSE-MGMT-MIB.  Note: The
	// license index can be '0' if no license is installed for the next boot. The
	// type is interface{} with range: 0..4294967295.
	CilmNextBootLicenseIndex interface{}
}

CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry An entry in the table for each module containing the list of objects that define the configuration of next boot level. The following information is specified by the objects present in the table.

- Current image level. - Configured image level for the next boot. - Actual image level for the next boot. - License store index for the current license. - License index of the current license. - License store index for the next boot license. - License index of the next boot license.

func (*CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry) GetEntityData 

func (cilmBootImageLevelEntry *CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable 

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

	// An entry in the table containing the following information. - The image
	// levels at the which the modules can be run. - The license required to the
	// run a module at a particular image level. - The priority of the license.
	// The type is slice of
	// CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry.
	CilmImageLevelToLicenseMapEntry []*CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry
}

CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable This table contains the mapping between different image levels of each modules in the image and the license required to run the modules at a particular image level. This table can be used to identify the different image levels and the appropriate licenses required for each.

func (*CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable) GetEntityData 

func (cilmImageLevelToLicenseMapTable *CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry 

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

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to
	// entity_mib.ENTITYMIB_EntPhysicalTable_EntPhysicalEntry_EntPhysicalIndex
	EntPhysicalIndex interface{}

	// This attribute is a key. The type is string. Refers to
	// cisco_image_license_mgmt_mib.CISCOIMAGELICENSEMGMTMIB_CilmBootImageLevelTable_CilmBootImageLevelEntry_CilmModuleName
	CilmModuleName interface{}

	// This attribute is a key. This is a running index used to identify an entry
	// of this table. The type is interface{} with range: 0..4294967295.
	CilmImageLicenseMapIndex interface{}

	// This object indicates the image level at which a module can be run. A
	// module can be run at different image levels. An entry will be created in
	// this table for every module and image level combination. The type is string
	// with length: 0..255.
	CilmImageLicenseImageLevel interface{}

	// This object indicates the list of licenses needed to be installed for the
	// module to run at the image level mentioned by cilmImageLicenseImageLevel
	// object of this entry. The type is string with length: 0..255.
	CilmImageLicenseName interface{}

	// This object indicates the priority of the image level mentioned by
	// cilmImageLicenseImageLevel object of this entry. The image level with the
	// highest priority license will be considered as the default level in the
	// absense of next boot image level configuration. For example if there are
	// three licenses l1, l2 and l3 in the ascending order of priority, then by
	// default l1 will be the level at which the module will be running. If the
	// next boot level is configured then the configuration will override the
	// priority. The highest priority license supports a feature set which is a
	// super set of all other licenses. The type is interface{} with range:
	// 1..255.
	CilmImageLicensePriority interface{}
}

CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry An entry in the table containing the following information. - The image levels at the which the modules can be run. - The license required to the run a module at a particular image level. - The priority of the license.

func (*CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry) GetEntityData 

func (cilmImageLevelToLicenseMapEntry *CISCOIMAGELICENSEMGMTMIB_CilmImageLevelToLicenseMapTable_CilmImageLevelToLicenseMapEntry) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CilmNotifCntl 

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

	// Specify whether or not a notification should be generated on the detection
	// of change in next boot image level.  If set to TRUE,
	// cilmBootImageLevelChanged notification will be generated. It is the
	// responsibility of the management entity to ensure that the SNMP
	// administrative model is configured in such a way as to allow the
	// notification to be delivered. The type is bool.
	CilmImageLevelChangedNotif interface{}
}

CISCOIMAGELICENSEMGMTMIB_CilmNotifCntl

func (*CISCOIMAGELICENSEMGMTMIB_CilmNotifCntl) GetEntityData 

func (cilmNotifCntl *CISCOIMAGELICENSEMGMTMIB_CilmNotifCntl) GetEntityData() *types.CommonEntityData

type CISCOIMAGELICENSEMGMTMIB_CiscoImageLicenseMgmtMIBObjects 

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

	// This object when set to TRUE means that the user has accepted the END USER
	// LICENSE AGREEMENT. This object has to be set to TRUE by the user before
	// using the objects in the cilmBootImageLevelTable to configure the license.
	// The type is bool.
	CilmEULAAccepted interface{}
}

CISCOIMAGELICENSEMGMTMIB_CiscoImageLicenseMgmtMIBObjects

func (*CISCOIMAGELICENSEMGMTMIB_CiscoImageLicenseMgmtMIBObjects) GetEntityData 

func (ciscoImageLicenseMgmtMIBObjects *CISCOIMAGELICENSEMGMTMIB_CiscoImageLicenseMgmtMIBObjects) 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.