midcomRuleAdminStatus
MIDCOM-MIB ·
.1.3.6.1.2.1.171.1.1.3.1.4
Object
column
r/w
Enumeration
The value of this object indicates the desired status of
the policy rule. See the definition of midcomRuleOperStatus
for a description of the values.
When a midcomRuleEntry is created without explicitly setting
this object, its value will be notSet(3).
However, a SET request can only set this object to either
reserve(1) or enable(2). Attempts to set this object to
notSet(3) will always fail with an 'inconsistentValue'
error. Note that this error code is SNMP specific. If the
MIB module is used with other protocols than SNMP, errors
with similar semantics specific to those protocols should
be returned.
When the midcomRuleAdminStatus object is set, then the
MIDCOM-MIB implementation will try to read the respective
relevant objects of the entry and try to achieve the
corresponding midcomRuleOperStatus.
Setting midcomRuleAdminStatus to value reserve(1) when
object midcomRuleOperStatus has a value of reserved(7)
does not have any effect on the policy rule.
Setting midcomRuleAdminStatus to value enable(2) when
object midcomRuleOperStatus has a value of enabled(8)
does not have any effect on the policy rule.
Depending on whether the midcomRuleAdminStatus is set to
reserve(1) or enable(2), several objects must be set in
advance. They serve as parameters of the policy rule to be
established.
When object midcomRuleAdminStatus is set to reserve(1),
then the following objects in the same entry are of
relevance:
- midcomRuleInterface
- midcomRuleTransportProtocol
- midcomRulePortRange
- midcomRuleInternalIpVersion
- midcomRuleExternalIpVersion
- midcomRuleInternalIpAddr
- midcomRuleInternalIpPrefixLength
- midcomRuleInternalPort
- midcomRuleLifetime
MIDCOM-MIB implementation may also consider the value
of object midcomRuleMaxIdleTime when establishing
a reserve rule.
When object midcomRuleAdminStatus is set to enable(2),
then the following objects in the same entry are of
relevance:
- midcomRuleInterface
- midcomRuleFlowDirection
- midcomRuleMaxIdleTime
- midcomRuleTransportProtocol
- midcomRulePortRange
- midcomRuleInternalIpVersion
- midcomRuleExternalIpVersion
- midcomRuleInternalIpAddr
- midcomRuleInternalIpPrefixLength
- midcomRuleInternalPort
- midcomRuleExternalIpAddr
- midcomRuleExternalIpPrefixLength
- midcomRuleExternalPort
- midcomRuleLifetime
When retrieved, the object returns the last set value.
If no value has been set, it returns the default value
notSet(3).
Context
- MIB
- MIDCOM-MIB
- OID
.1.3.6.1.2.1.171.1.1.3.1.4- Type
- column
- Access
- readwrite
- Status
- current
- Parent
- midcomRuleEntry
- Table
- midcomRuleTable
- Siblings
- 25
Syntax
Enumeration
Values & Constraints
Enumerated Values
1 | reserve |
2 | enable |
3 | notSet |
Related Objects
Sibling Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| midcomRuleOwner The manager who owns this row in the midcomRuleTable.
This object SHOULD uniquely identify an authenticated
MIDCOM client. This object is part of the table index t… | column | OctetString | .1.3.6.1.2.1.171.1.1.3.1.1 |
| midcomRuleFlowDirection This parameter specifies the direction of enabled
communication, either inbound(1), outbound(2), or
biDirectional(3).
The semantics of this object depends on the pr… | column | Enumeration | .1.3.6.1.2.1.171.1.1.3.1.10 |
| midcomRuleMaxIdleTime Maximum idle time of the policy rule in seconds.
If no packet to which the policy rule applies passes the
middlebox for the specified midcomRuleMaxIdleTime, then
th… | column | seconds SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.171.1.1.3.1.11 |
| midcomRuleTransportProtocol The transport protocol.
Valid values for midcomRuleTransportProtocol
other than zero are defined at:
http://www.iana.org/assignments/protocol-numbers
… | column | Unsigned32 | .1.3.6.1.2.1.171.1.1.3.1.12 |
| midcomRulePortRange The range of port numbers.
This object is used as input to a request for establishing
a policy rule as well as for indicating the properties of
an established polic… | column | Enumeration | .1.3.6.1.2.1.171.1.1.3.1.13 |
| midcomRuleInternalIpVersion IP version of the internal address (A0) and the inside
address (A1). Allowed values are ipv4(1), ipv6(2),
ipv4z(3), and ipv6z(4).
This object is used as input to a… | column | INET-ADDRESS-MIBInetAddressType | .1.3.6.1.2.1.171.1.1.3.1.14 |
| midcomRuleExternalIpVersion IP version of the external address (A3) and the outside
address (A2). Allowed values are ipv4(1) and ipv6(2).
This object is used as input to a request for establi… | column | INET-ADDRESS-MIBInetAddressType | .1.3.6.1.2.1.171.1.1.3.1.15 |
| midcomRuleInternalIpAddr The internal IP address (A0).
This object is used as input to a request for establishing
a policy rule as well as for indicating the properties of
an established po… | column | INET-ADDRESS-MIBInetAddress | .1.3.6.1.2.1.171.1.1.3.1.16 |
| midcomRuleInternalIpPrefixLength The prefix length of the internal IP address used for
wildcarding. A value of 0 indicates a full wildcard;
in this case, the value of midcomRuleInternalIpAddr is
irrelevant. If … | column | INET-ADDRESS-MIBInetAddressPrefixLength | .1.3.6.1.2.1.171.1.1.3.1.17 |
| midcomRuleInternalPort The internal port number. A value of 0 is a wildcard.
This object is used as input to a request for establishing
a policy rule as well as for indicating the proper… | column | INET-ADDRESS-MIBInetPortNumber | .1.3.6.1.2.1.171.1.1.3.1.18 |
| midcomRuleExternalIpAddr The external IP address (A3).
This object is used as input to a request for establishing
a policy rule as well as for indicating the properties of
an established po… | column | INET-ADDRESS-MIBInetAddress | .1.3.6.1.2.1.171.1.1.3.1.19 |
| midcomRuleExternalIpPrefixLength The prefix length of the external IP address used for
wildcarding. A value of 0 indicates a full wildcard;
in this case, the value of midcomRuleExternalIpAddr is
irrelevant. If … | column | INET-ADDRESS-MIBInetAddressPrefixLength | .1.3.6.1.2.1.171.1.1.3.1.20 |
| midcomRuleExternalPort The external port number. A value of 0 is a wildcard.
This object is used as input to a request for establishing
a policy rule as well as for indicating the proper… | column | INET-ADDRESS-MIBInetPortNumber | .1.3.6.1.2.1.171.1.1.3.1.21 |
| midcomRuleInsideIpAddr The inside IP address at the middlebox (A1).
The value of this object is relevant only if
object midcomRuleOperStatus of the same entry has
a value of either reserv… | column | INET-ADDRESS-MIBInetAddress | .1.3.6.1.2.1.171.1.1.3.1.22 |
| midcomRuleInsidePort The inside port number at the middlebox.
A value of 0 is a wildcard.
The value of this object is relevant only if
object midcomRuleOperStatus of the same entry has
… | column | INET-ADDRESS-MIBInetPortNumber | .1.3.6.1.2.1.171.1.1.3.1.23 |
| midcomRuleOutsideIpAddr The outside IP address at the middlebox (A2).
The value of this object is relevant only if
object midcomRuleOperStatus of the same entry has
a value … | column | INET-ADDRESS-MIBInetAddress | .1.3.6.1.2.1.171.1.1.3.1.24 |
| midcomRuleOutsidePort The outside port number at the middlebox.
A value of 0 is a wildcard.
The value of this object is relevant only if
object midcomRuleOperStatus of the same entry has… | column | INET-ADDRESS-MIBInetPortNumber | .1.3.6.1.2.1.171.1.1.3.1.25 |
| midcomRuleLifetime The remaining lifetime in seconds of this policy rule.
Lifetime of a policy rule starts when object
midcomRuleOperStatus in the same entry enters either
state reser… | column | seconds SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.171.1.1.3.1.26 |
| midcomRuleRowStatus A control that allows entries to be added and removed from
this table.
Entries can also be removed from this table by setting
objects midcomRuleLifetime and midcomR… | column | SNMPv2-TCRowStatus | .1.3.6.1.2.1.171.1.1.3.1.27 |
| midcomRuleIndex The value of this object must be unique in
combination with the values of the objects
midcomRuleOwner and midcomGroupIndex in this row. | column | Unsigned32 | .1.3.6.1.2.1.171.1.1.3.1.3 |
| midcomRuleOperStatus The actual status of the policy rule. The
midcomRuleOperStatus object may have the following values:
- newEntry(1) indicates that the entry in the
midcomRuleTabl… | column | Enumeration | .1.3.6.1.2.1.171.1.1.3.1.5 |
| midcomRuleStorageType When retrieved, this object returns the storage
type of the policy rule. Writing to this object can
change the storage type of the particular row from
volatile(2) to nonVolatile(… | column | SNMPv2-TCStorageType | .1.3.6.1.2.1.171.1.1.3.1.6 |
| midcomRuleStorageTime The value of this object specifies how long this row
can exist in the midcomRuleTable after the
midcomRuleOperStatus switched to a termination state or
to an error state. This ob… | column | seconds SNMPv2-SMIUnsigned32 | .1.3.6.1.2.1.171.1.1.3.1.7 |
| midcomRuleError This object contains a descriptive error message if
the transition into the operational status reserved(7)
or enabled(8) failed. Implementations must reset the
error message to a… | column | SNMP-FRAMEWORK-MIBSnmpAdminString | .1.3.6.1.2.1.171.1.1.3.1.8 |
| midcomRuleInterface This object indicates the IP interface for which
enforcement of a policy rule is requested or performed,
respectively.
The interface is identified by its index in t… | column | IF-MIBInterfaceIndexOrZero | .1.3.6.1.2.1.171.1.1.3.1.9 |