Network\CIM_BGPProtocolEndpoint.mof.mof (HTML version)

Return to index
CIM_BGPProtocolEndpoint Superclass: CIM_ProtocolEndpoint
A ProtocolEndpoint that is dedicated to running BGP.
Qualifiers:Version ( "2.8.0" ) UMLPackagePath ( "CIM::Network::ProtocolEndpoints" )
Parameters (local in grey)
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerMinASOriginationInterval" }
Units ( "Seconds" )
uint16 MinASOriginationInterval = 15 ;
This defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerLocalAddr" }
Deprecated { "CIM_BindsTo" , "CIM_IPProtocolEndpoint" }
string LocalAddress ;
This is the local IP address of this router's BGP connection. It is deprecated since a binding should be defined using the CIM_BindsTo association. Ideally the binding is to a TCPProtocolEndpoint which then handles the association to its IPEndpoint.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerRemoteAddr" }
Deprecated { "CIM_BindsTo" , "CIM_RemoteServiceAccessPoint" }
string RemoteAddress ;
This is the remote IP address of this router's BGP connection. It is deprecated since a binding to a Remote ServiceAccessPoint should be instantiated, using CIM_BindsTo.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerLocalPort" }
Deprecated { "CIM_BindsTo" , "CIM_TCPProtocolEndpoint" }
uint16 LocalPort ;
This is the local port number for the TCP connection of this router's BGP connection. It is deprecated since a binding should be defined (to a TCPProtocolEndpoint) using the CIM_BindsTo association.
boolean IsEBGPMultihop ;
Normally, two routers running EBGP must be physically connected. This boolean, when TRUE, denotes a LOGICAL connection between two routers that are running EBGP (e.g., there is an intermediate router or interface between them).
ValueMap { "1" , "2" , "3" , "4" , "5" , "6" }
Values { "Idle" , "Connect" , "Active" , "OpenSet" , "OpenConfirm" , "Established" }
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerState" }
uint16 State ;
This defines the current connection state of the BGP Peer.
ValueMap { "1" , "225..4095" , "4108" , "4301..32767" , "32768.." }
Values { "Other" , "IANA Reserved" , "BGP" , "DMTF Reserved" , "Vendor Reserved" }
Override ( "ProtocolIFType" )
uint16 ProtocolIFType = 4108 ;
ProtocolIFType's enumeration is limited to BGP and reserved values for this subclass of ProtocolEndpoint.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerKeepAlive" }
Units ( "Seconds" )
uint16 KeepAlive ;
This defines the time interval in seconds for the KeepAlive timer established with the peer. The value of this property is calculated by the speaker such that, when compared with the HoldTime property, it has the same proportion as the KeepAliveConfigured property has with the HoldTimeConfigured property. A value of 0 indicates that the KeepAlive timer has not yet been established. The maximum value of this property is 21845 seconds.
boolean IsEBGP ;
A boolean that, when TRUE, signifies that this is an instance of the external version of BGP (FALSE is the internal version).
MappingStrings { "MIB.IETF|BGP4-MIB.bgpIdentifier" }
string LocalIdentifier ;
This is the unique identifier of the local BGP router. This is often the router ID (e.g., an IP address).
ValueMap { "1" , "2" }
Values { "Stop" , "Start" }
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerAdminStatus" }
Deprecated { "CIM_EnabledLogicalElement.RequestedState" }
uint16 AdminStatus ;
This defines the desired state of the BGP connection. It is equivalent to the RequestedState property (i.e., enabled/disabled status) that is inherited from EnabledLogicalElement. AdminStatus is deprecated in lieu of this inherited property.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpConnectRetryInterval" }
Units ( "Seconds" )
uint32 ConnectRetryInterval = 120 ;
This defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerKeepAliveConfigured" }
Units ( "Seconds" )
uint16 KeepAliveConfigured = 30 ;
This defines the time interval in seconds for the KeepAlive timer configured for this BGP speaker with a peer. This value will determine the frequency of the KEEPALIVE messages relative to the value of the HoldTimeConfigured property; the actual frequency is specified by the value of the KeepAlive property. A reasonable value is one third of that of the value of the HoldTimeConfigured property. If it is zero, then NO periodic KEEPALIVE messages are sent to the peer. The suggested value for this property is 30 seconds. The maximum value of this property is 21845 seconds.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerIdentifier" }
string PeerIdentifier ;
This is the unique identifier of the peer BGP router. This is often the router ID (e.g., an IP address).
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerNegotiatedVersion" }
string NegotiatedVersion ;
This defines the negotiated version of BGP that is running between the two peers.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerRemotePort" }
Deprecated { "CIM_BindsTo" , "CIM_RemotePort" }
uint16 RemotePort ;
This is the remote port number for the TCP connection of this router's BGP connection. It is deprecated since a binding to a RemotePort should be instantiated, using CIM_BindsTo.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerHoldTimeConfigured" }
Units ( "Seconds" )
uint16 HoldTimeConfigured = 90 ;
This defines the time interval in seconds for the Hold Time configured for this BGP speaker with a peer. This value is placed in an OPEN message sent to a peer by this BGP speaker, and is compared with the Hold Time field in the OPEN message received from the peer. It enables this speaker to establish a mutually agreeable Hold Time with the peer. This value must not be less than three seconds. If it is zero, then the Hold Time is NOT to be established with the peer. The suggested value for this timer is 90 seconds.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerHoldTime" }
Units ( "Seconds" )
uint16 HoldTime ;
This defines the maximum amount of time in seconds that may elapse between the receipt of successive KEEPALIVE or UPDATE messages. This is instrumented as a counter that increments from zero to the value specified in this property. The value of this property is calculated by the BGP speaker by using the smaller of the values of bgpPeerHoldTimeConfigured and the Hold Time received in the OPEN message. This value, if not zero seconds, must be at least three seconds, up to a maximum of 65535 seconds. Receipt of either a KEEPALIVE or an UPDATE message resets this value.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerMinRouteAdvertisementInterval" }
Units ( "Seconds" )
uint16 MinRouteAdvertisementInterval = 30 ;
This defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds.
MappingStrings { "MIB.IETF|BGP4-MIB.bgpPeerRemoteAs" }
uint16 RemoteAS ;
This is the remote AS number for this router's BGP connection.
MappingStrings { "MIB.IETF|IF-MIB.ifLastChange" }
Override ( "TimeOfLastStateChange" )
datetime TimeOfLastStateChange ;
MappingStrings { "MIB.IETF|IF-MIB.ifOperStatus" }
Override ( "OperationalStatus" )
uint16 OperationalStatus [ ] ;
MaxLen ( 64 )
ModelCorrespondence { "CIM_ProtocolEndpoint.ProtocolType" , "CIM_ProtocolEndpoint.ProtocolIFType" }
string OtherTypeDescription ;
A string describing the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (i.e., 'Other'). This property should be set to NULL when the Type property is any value other than 1.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , "22" , "23" , "24" , "25" , "26" , "27" }
Values { "Unknown" , "Other" , "IPv4" , "IPv6" , "IPX" , "AppleTalk" , "DECnet" , "SNA" , "CONP" , "CLNP" , "VINES" , "XNS" , "ATM" , "Frame Relay" , "Ethernet" , "TokenRing" , "FDDI" , "Infiniband" , "Fibre Channel" , "ISDN BRI Endpoint" , "ISDN B Channel Endpoint" , "ISDN D Channel Endpoint" , "IPv4/v6" , "BGP" , "OSPF" , "MPLS" , "UDP" , "TCP" }
ModelCorrespondence { "CIM_ProtocolEndpoint.OtherTypeDescription" }
Deprecated { "CIM_ProtocolEndpoint.ProtocolIFType" }
uint16 ProtocolType ;
ProtocolType is an enumeration providing information to categorize and classify different instances of this class. For most instances, information in this enumeration and the subclass' definition overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Hence, this property is needed to define the type of Endpoint.

This property is deprecated in lieu of the ProtocolIFType enumeration. This is done to have better alignment between the IETF's IF-MIB and this CIM class.
MaxLen ( 256 )
string NameFormat ;
NameFormat contains the naming heuristic that is chosen to ensure that the value of the Name property is unique. For example, one might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint that this instance is (e.g., IPv4) followed by an underscore.
MappingStrings { "MIB.IETF|IF-MIB.ifDescr" }
Override ( "Description" )
string Description ;
MaxLen ( 256 )
Override ( "Name" )
string Name ;
A string which identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method chosen is described in the NameFormat property of this class.
MappingStrings { "MIB.IETF|IF-MIB.ifAdminStatus" }
Override ( "EnabledState" )
uint16 EnabledState ;
MaxLen ( 256 )
Propagated ( "CIM_System.CreationClassName" )
Key
string SystemCreationClassName ;
The CreationClassName of the scoping System.
MaxLen ( 256 )
Propagated ( "CIM_System.Name" )
Key
string SystemName ;
The Name of the scoping System.
MaxLen ( 256 )
Key
string CreationClassName ;
CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ('Other'). This property must be set to null when EnabledState is any value other than 1.
ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" }
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" }
Write
uint16 EnabledDefault = 2 ;
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is 'Enabled' (value=2).
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
uint32RequestStateChange(
The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
Qualifiers:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } IN
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.

Qualifiers:IN
datetime TimeoutPeriod
)
Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 RequestedState = 12 ;
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ('Not Applicable'), then this property has no meaning. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.

It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are 'Reboot' (10) and 'Reset' (11). Reboot refers to doing a 'Shut Down' and then moving to an 'Enabled' state. Reset indicates that the element is first 'Disabled' and then 'Enabled'. The distinction between requesting 'Shut Down' and 'Disabled' should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.

A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string StatusDescriptions [ ] ;
Strings describing the various OperationalStatus array values. For example, if 'Stopping' is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
string Status ;
A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons:
1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
uint16 HealthState ;
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
'Non-recoverable Error' (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
'Critical Failure' (25) - The element is non-functional and recovery might not be possible.
'Major Failure' (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
'Minor Failure' (15) - All functionality is available but some might be degraded.
'Degraded/Warning' (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.
'OK' (5) - The element is fully functional and is operating within normal operational parameters and without error.
'Unknown' (0) - The implementation cannot report on HealthState at this time.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
string ElementName ;
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.