CIgmpFilterEditor¶

Enum Classes

class CISCOIGMPFILTERMIB::CIgmpFilterEditor¶

Bases: Entity

Class Hierarchy : CISCOIGMPFILTERMIB CIgmpFilterEditor

This class represents state data.

cigmpfiltereditspinlock¶

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

type: int

range: 0..2147483647

config: False

cigmpfiltereditprofileindex¶

Buffer object to edit corresponding object cIgmpFilterProfileIndex in cIgmpFilterTable. Maximum value this object can be set to is determined by cIgmpFilterMaxProfiles object

type: int

range: 0..4294967295

config: False

cigmpfiltereditstartaddresstype¶

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

type: InetAddressType

config: False

cigmpfiltereditstartaddress¶

Buffer object to edit corresponding object cIgmpFilterStartAddress in cIgmpFilterTable to establish start address of filtering range for a profile

type: std::string

length: 1..64

config: False

cigmpfiltereditendaddresstype¶

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

type: InetAddressType

config: False

cigmpfiltereditendaddress¶

Buffer object to edit corresponding object cIgmpFilterEndAddress in cIgmpFilterTable to establish end address of filtering range for a profile

type: std::string

length: 0..255

config: False

cigmpfiltereditprofileaction¶

Buffer object to edit corresponding object in cIgmpFilterTable to determine filtering action of each profile

type: CIgmpFilterEditProfileAction

config: False

cigmpfiltereditoperation¶

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

type: CIgmpFilterEditOperation

config: False

cigmpfilterapplystatus¶

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

type: CIgmpFilterApplyStatus

config: False