Internet-Draft Ryan Moats draft-moats-dmtf-network-ldap-01.txt Gerald Maziarski Expires in six months AT&T John Strassner cisco Systems December 1999 LDAP Schema for the DMTF Network CIM v2.2 Model Filename: draft-moats-dmtf-network-ldap-01.txt Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Abstract This draft presents a LDAP schema for the DMTF CIM Network model version 2.2 [4]. 1. Introduction This draft presents a LDAPv3 [1,2] schema for the DMTF CIM Network model. Associations are mapped using a combination of auxiliary classes and DIT structure rules. Where auxiliary classes are used, name form and DIT content rules are specified. This document is not a product of the DMTF, and represents the view of the authors. Expires 6/30/00 [Page 1] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 2. LDAP Mapping Considerations 2.1 Differences Between this Mapping and the CIM Device Model There are some differences between the classes and associations specified in the CIM model and the schema here. First, because the core model requires services to be contained by systems the NetworkServicesInAdminDomain association doesn't add any new information. Second, there are a couple of classes that don't have structural rules specified for them as they don't specify any new RDNs. There are a couple of namespace collisions between this model and and other models, a couple of attributes in this model have been renamed. Finaly, the classes TransparentBridgingStatistics, SpanningTreeStatistics, SwitchPortStatistics, SwitchPortTransparentBridingStatistics, SwitchPortSpanningTreeStatistics, SwitchPortSourceRoutingStatisitcs, BGPStatistics, and BGPServiceStatistics aren't included as they contain counter information that is considered too dynamic for directory storage. 2.2 Changes to cimAssociationInstance The core mapping [3] defined cimAssociationInstance as a helper class. To support the auxiliary classes, the following classes should be added to cimAssociationInstance's content rule: Also, the following structure rules defined here need to be added to the structure rule for cimAssociationInstance: 3. Class Definitions For efficiency in the LDAP representation, associations are specified as a combination of auxiliary classes and DIT structure rules. Attribute definitions for each class are presented with the object class. Other definitions are also provided when necessary. This approach minimizes the number of DN pointers stored in the schema, but some pointer dereferencing is necessary. While not explicitly stated in the definitions below, we assume that all attributes with DN support the matching rule defined in [3]. Attribute names for DN pointers also follow the convention that a single pointer's name ends in "Ref", while an array of pointers' name ends in "Refs". Note: all attribute, object class, and name form OIDs are place holders, and syntax OIDs in definitions have been replaced by names for clarity. Expires 6/30/00 [Page 2] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.1 cim22AdminDomain This is a special grouping of cim22ManagedSystemElement objects that are all administered by the same user or group of users. It serves as an aggregation point to associate one or more of the following elements: network devices, such as routers and switches, servers, and other resources that can be accessed by end systems. This grouping of devices plays an essential role in ensuring that the same administrative POLICY is applied to all the devices in the grouping. ( NAME 'cim22AdminDomain' DESC 'This is a special grouping of ManagedSystemElements that are all administered by the same user or group of users. It serves as an aggregation point to associate one or more of the following elements: network devices, such as routers and switches, servers, and other resources that can be accessed by end systems. This grouping of devices plays an essential role in ensuring that the same administrative POLICY is applied to all of the devices in the grouping.' SUP cim22System ) ( NAME 'cim22AdminDomainNameForm' OC cim22AdminDomain MUST (orderedCimModelPath) ) ( NAME 'cim22AdminDomainStructureRule' FORM cim22AdminDomainNameForm ) 3.2 cim22NetworkService This base class is derived from the cim22Service class. It serves as the root of the network service hierarchy. Network services represent generic functions that are available from the network that configure and/or change the traffic being sent. For example, FTP is not a network service, as it simply passes data unchanged from source to destination. On the other hand, services that provide quality of service (e.g., DiffServ) and security (e.g., IPSec) do affect the traffic stream. Quality of service, IPSec, and other services are subclasses of this class. This class hierarchy enables developers to match services to users, groups, and other objects in the network. ( NAME 'cimKeywords' DESC 'This is a free-form array of strings that provide descriptive words and phrases that can be used in queries to help locate and identify instances of this service.' Expires 6/30/00 [Page 3] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 SYNTAX string ) ( NAME 'cimServiceURL' DESC 'This is a URL that provides the protocol, network location, and other service-specific information required in order to access the service. This should be implemented as a LabeledURI, with syntax DirectoryString and a matching rule of CaseExactMatch, for directory implementors.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimStartupConditions' DESC 'This is a free-form array of strings that specify any specific pre-conditions that must be met in order for this service to start correctly.' SYNTAX string ) ( NAME 'cimStartupParameters' DESC 'This is a free-form array of strings that specify any specific parameters that must be supplied to the StartService() method in order for this service to start correctly.' SYNTAX string ) ( NAME 'cim22NetworkService' DESC 'This is the root of the network service hierarchy. Network services represent generic functions that are available from the network that configure and/or modify the traffic being sent. For example, FTP is not a network service, as it simply passes data unchanged from source to destination. On the other hand, services that provide quality of service (e.g., DiffServ) and security (e.g., IPSec) do affect the traffic stream. Quality of service, IPSec, and other services are subclasses of this class. This class hierarchy enables developers to match services to users, groups, and other objects in the network.' SUP cim22Service MAY (cimKeywords $ cimServiceURL $ cimStartupConditions $ cimStartupParameters) ) The following content rule specifies the auxiliary classes that may be attached to cim22NetworkService. Expires 6/30/00 [Page 4] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cim22NetworkServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22NetworkService' AUX (cim22LogicalNetworkServiceAuxClass $ cim22ProvidesEndpointAuxClass) ) 3.3 cim22ForwardingService This class represents the forwarding of network traffic by receiving data from one or more protocol endpoints and sending that data via other protocol endpoints. This class is different from the cim22RouteCalculationService class in that it represents a way to forward traffic independent of calculating routing information (e.g., using static routing). Generally, the endpoints a forwarding service routes data among are at the same protocol layer and are usually of similar types or of the same type. Examples of this service include routing, bridging, and repeating services. ( NAME 'cimProtocolType' DESC 'This defines the type of protocol that is being forwarded.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOtherProtocolType' DESC 'This defines the type of protocol that is being forwarded when the value of the ProtocolType attribute is 1 (e.g., "Other"). This provides for future extensibility.' SYNTAX string{32} SINGLE-VALUE ) ( NAME 'cim22ForwardingService' DESC 'This class represents the forwarding of network traffic by receiving data from one or more ProtocolEndpoints and sending that data via other ProtocolEndpoints. This class is different than the RouteCalculationService class in that it represents a way to forward traffic independent of calculating routing information (e.g., using static routing). Generally, the endpoints among which a ForwardingService routes data are at the same protocol layer and are usually of similar types or of the same type. Examples of this kind of service include routing, bridging, and repeating services. Instances of this class will have ForwardsAmong associations to the ProtocolEndpoint instances among which forwarding is occurring.' SUP cim22NetworkService Expires 6/30/00 [Page 5] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 MAY (cimProtocolType $ cimOtherProtocolType) ) ( NAME 'cim22ForwardingServiceNameForm' OC cim22ForwardingService MUST (orderedCimModelPath) ) ( NAME 'cim22ForwardingServiceStructureRule' FORM cim22ForwardingServiceNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22ForwardingService. ( NAME 'cim22ForwardingServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22ForwardingService' AUX (cim22ForwardsAmongAuxClass) ) 3.4 cim22AutonomousSystem This class provides a structured view of routing by segregating the system that is using routing (e.g., the Internet, or an extranet) into a set of separately administered domains that each have their own independent routing policies. These domains are called autonomous systems. The classic definition of an AS, from RFC1771, is ...a set of routers under a single technical administration, using an interior gateway protocol and common metrics to route packets within the AS, and using an exterior gateway protocol to route packets to other ASs The RFC continues Since this classic definition was developed, it has become common for a single AS to use several interior gateway protocols and sometimes several sets of metrics within an AS. The use of the term Autonomous System here stresses that, even when multiple IGPs and metrics are used, the administration of an AS appears to other ASs to have a single coherent interior routing plan and presents a consistent picture of what destinations are reachable through it. ( NAME 'cimASNumber' DESC 'An ASNumber is an integer between 1 and 65535, with the range 64512 through 65535 reserved for private use. Every Expires 6/30/00 [Page 6] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 AS has a unique AS number, which is assigned to it by an Internet Registry or a provider. IANA assigns and administers AS numbers.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimIsSingleHomed' DESC 'IsSingleHomed is a boolean that, when its value is TRUE, indicates that this AS reaches networks outside of its domain through a single exit point. Whether a given AS is single-homed or not has important ramifications for BGP configuration.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimIsTransit' DESC 'IsTransit is a boolean that, when its value is TRUE, indicates that this AS will advertise routes that it learns from other ASs. A non- transit AS will only advertise its own routes.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimRequireIGPSync' DESC 'RequireIGPSync is a boolean that, when its value is TRUE, indicates that this AS must obey the following BGP rule: a BGP router should not advertise destinations learned from internal BGP neighbors to external BGP destinations unless those destinations are also known via some internal gateway protocol. Otherwise, a BGP router may receive traffic that cannot yet be routed. However, since this is a costly choice, it is common practice to allow this rule to be broken under certain carefully controlled circumstances.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimRoutingUpdateSource' DESC 'RoutingUpdateSource defines how routing information is to be injected into BGP. Statically injected routes are maintained by the routing table and are independent of the status of the networks that they refer to. This is done by defining static routes in the BGP routing table. Dynamically injected routes are of two types. Dynamic routes refer to distributing all of the IGP routes into BGP. Semi-dynamic routes define a set of specific IGP routes that will be injected into BGP.' SYNTAX integer SINGLE-VALUE ) Expires 6/30/00 [Page 7] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimAggregationType' DESC 'Route aggregation refers to summarizing ranges of routes into one or more aggregate routes. This is done to minimize the number of routes in the global routing table. A potential drawback is that specific path information (e.g., AS_Path attribute value) is lost, which may lead to potential routing loops. There are a variety of ways to ensure that this does not happen. Note, however, that BGP4 is required to do this. There are many ways to form aggregate routes. The following are the most popular: "Aggregate only", where only the aggregate is advertised, and all of its more specific routes are suppressed; "Aggregate Plus Specific Routes", where both the aggregate as well as its more specific routes are advertised (e.g., send the aggregate to the NAP, but send the more specific routes to providers); "Aggregate Based on a Subset of Specific Routes", where the aggregate route is formed by looking at certain more specific routes and forming an aggregate on them, suppressing all others.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22AutonomousSystem' DESC 'An Autonomous System (AS) is a fundamental concept in networking. An AS provides a structured view of routing by segregating the system that is using routing (e.g., the Internet, or an extranet) into a set of separately administered domains that each have their own independent routing policies. These domains are called autonomous systems.' SUP cim22AdminDomain MAY (cimASNumber $ cimIsSingleHomed $ cimIsTransit $ cimRequireIGPSync $ cimRoutingUpdateSource $ cimAggregationType) ) The following content rule specifies the auxiliary classes that may be attached to cim22AutonomosSystem. ( NAME 'cim22AutonomousSystemContentRule' DESC 'The auxiliary classes that may be attached to cim22AutonomousSystem' AUX (cim22BGPClustersInASAuxClass $ cim22RoutersInASAuxClass $ cim22ASBGPEndpointsAuxClass $ cim22ConfederationAuxClass) ) Expires 6/30/00 [Page 8] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.5 cim22LogicalNetwork The cim22LogicalNetwork object groups together a set of cim22ProtocolEndpoint objects of a given type that are able to communicate with each other directly. It is used for describing the characteristics of the grouping and/or its associated medium. This class represents the ability to send and/or receive data over a network. ( NAME 'cimType' DESC 'Type is an enumeration that provides additional information that can be used to help categorize and classify different instances of this class . Subclasses should ensure that they are of the appropriate type defined in the Type enumeration. That is, the IPSubnet subclass should define its property as either IPv4 or IPv6, as opposed to, for example, ATM.' SYNTAX string{64} SINGLE-VALUE ) ( NAME 'cim22LogicalNetwork' DESC 'A LogicalNetwork groups together a set of ProtocolEndpoints of a given type which are able to communicate with each other directly. It is used for describing the characteristics of the grouping and/or its associated medium. A LogicalNetwork represents the ability to send and/or receive data over a network.' SUP cim22CollectionOfMSEs MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName $ orderedCimModelPath) MAY (cimType $ cimOtherTypeDescription) ) ( NAME 'cim22LogicalNetworkNameForm' OC cim22LogicalNetwork MUST (orderedCimModelPath) ) ( NAME 'cim22LogicalNetworkStructureRule' FORM cim22LogicalNetworkNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22LogicalNetwork ( NAME 'cim22LogicalNetworkContentRule' DESC 'The auxiliary classes that may be attached to Expires 6/30/00 [Page 9] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 cim22LogicalNetwork' AUX (cim22LogicalNetworkServiceAuxClass $ cim22InLogicalNetworkAuxClass $ cim22CollectedMSEsAuxClass $ cim22CollectedCollectionsAuxClass $ cim22CollectionConfigurationAuxClass $ cim22CollectionSettingAuxClass) ) 3.6 cim22LogicalNetworkServiceAuxClass This auxiliary class represents network services that either originate and/or terminate in a logical network. This enables management applications to more easily identify services that are provided by particular network devices. ( NAME 'cimNetworkRef' DESC 'The LogicalNetwork that contains the network service.' SYNTAX DN ) ( NAME 'cimNetworkServiceRef' DESC 'The NetworkService that is running in the LogicalNetwork. ' SYNTAX DN ) ( NAME 'cimContainmentType' DESC 'An enumeration that explicitly defines this network service as originating, terminating, or residing in this LogicalNetwork.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22LogicalNetworkServiceAuxClass' DESC 'A LogicalNetworkService represents network services that either originate and/or terminate in a LogicalNetwork. This enables management applications to more easily identify services that are provided by particular network devices. Attribute cimNetworkRef points to cim22LogicalNetwork. Attribute cimNetworkServiceRef points to cim22NetworkService.' SUP top AUXILIARY MAY (cimNetworkRef $ cimNetworkServiceRef $ cimContainmentType) ) 3.7 cim22IPSubnet This class represents a group of related cim22IPProtocolEndpoint objects that can communicate with each other directly using IP. It is Expires 6/30/00 [Page 10] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 used for describing the characteristics of the grouping. ( NAME 'cimSubnetNumber' DESC 'The IP address of the entire subnet, formatted according to the appropriate convention as defined in the AddressType property of this class. Note that CIDR format is not supported for this release. This is because, without more formal methods like constraints, it is possible to create different instances of the same object that have different naming formats. IPv4-compatible addresses should be used instead of IPv6 addresses (see RFC 2373, section 2.5.4). In order to have a consistent format for IPv4 addresses in a mixed IPv4/v6 environment, all IPv4 addresses and both IPv4-compatible IPv6 addresses and IPv4-mapped IPv6 addresses, per RFC 2373, section 2.5.4, should be formatted in standard IPv4 format. However, this (the 2.2) version of the Network Common Model will not explicitly support mixed IPv4/IPv6 environments. This will be added in the 2.3 release.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimSubnetMask' DESC 'The mask for the starting IP address of the IPSubnet, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., "255.255.252.0").' SYNTAX string SINGLE-VALUE ) ( NAME 'cimAddressType' DESC 'An enumeration that describes the format of the address property. Addresses that can be formatted in IPv4 format, must be formatted that way to ensure mixed IPv4/IPv6 support.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22IPSubnet' DESC 'An IPSubnet represents a group of related IPProtocolEndpoints that can communicate with each other directly using IP. It is used for describing the characteristics of the grouping.' SUP cimLogicalNetwork MAY (cimSubnetNumber $ cimSubnetMask $ cimAddressType) ) Expires 6/30/00 [Page 11] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.8 cim22ProtocolEndpoint This class represents a communication point from which data may be sent or received. Objects of this class link router interfaces and switch ports to logical networks. ( NAME 'cim22ProtocolEndpoint' DESC 'A communication point from which data may be sent or received. ProtocolEndpoints link router interfaces and switch ports to LogicalNetworks.' SUP cim22ServiceAccessPoint MAY (cimNameFormat $ cimType $ cimOtherTypeDescription $ cimSpeed $ cimMaxSpeed) ) The following content rule specifies the auxiliary classes that may be attached to cim22ProtocolEndpoint. ( NAME 'cim22ProtocolEndpointContentRule' DESC 'The auxiliary classes that may be attached to cim22ProtocolEndpoint' AUX (cim22ForwardsAmongAuxClass $ cim22InLogicalNetworkAuxClass $ cim22ActiveConnectionAuxClass $ cim22BindsToAuxClass $ cim22ProvidesEndpointAuxClass $ cim22CalculatesAmongAuxClass $ cim22EndpointIdentityAuxClass) ) 3.9 cim22ForwardsAmongAuxClass This auxiliary class represents the dependency that exists between protocol endpoints that are used to forward data and the forwarding service that is performing the forwarding of data. ( NAME 'cim22ForwardsAmongAuxClass' DESC 'This association represents the dependency that exists between the ProtocolEndpoints that are used to forward data and the ForwardingService that is performing the forwarding of data. Attribute cimAntecedentRef points to cim22ProtocolEndpoint and attribute cimDependentRef points to cim22ForwardingService.' SUP cim22ServiceSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) Expires 6/30/00 [Page 12] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.10 cim22LANEndpoint This object represents a communication endpoint that, when its associated interface device is connected to a LAN, may send and receive data frames. They link switch ports and host interfaces to LANs. ( NAME 'cimLANID' DESC 'A label or identifier for the LAN Segment.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimLANType' DESC 'An indication of the kind of technology used on the LAN.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOtherLANType' DESC 'A free-form string that describes the type of technology used on the LAN when the value of the LANType property is equal to 1 (e.g., "Other"). This provides built-in extensibility.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimMACAddress' DESC 'The principal unicast address used in communication with the LANEndpoint. The MAC address is formatted as twelve hexadecimal digits (e.g., "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order according to RFC 2469.' SYNTAX string{12} SINGLE-VALUE ) ( NAME 'cimAliasAddressesstring' DESC 'Other unicast addresses that may be used to communicate with the LANEndpoint.' SYNTAX string ) ( NAME 'cimGroupAddresses' DESC 'Multicast addresses to which the LANEndpoint listens.' SYNTAX string ) ( NAME 'cim22LANEndpoint' DESC 'A communication endpoint which, when its associated interface device is connected to a LAN, may send and Expires 6/30/00 [Page 13] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 receive data frames. LANEndpoints link switch ports and host interfaces to LANs. ' SUP cim22ProtocolEndpoint MAY (cimLANID $ cimLANType $ cimOtherLANType $ cimMACAddress $ cimAliasAddressesstring $ cimGroupAddresses $ cimMaxDataSize) ) The following content rule specifies the auxiliary classes that may be attached to cim22LANEndpoint. ( NAME 'cim22LANEndpointContentRule' DESC 'The auxiliary classes that may be attached to cim22LANEndpoint' AUX (cim22InSegmentAuxClass $ cim22BindsToLANEndpointAuxClass $ cim22SwitchableAuxClass) ) 3.11 cim22LANSegment This class represents a collection of LAN Endpoints of a particular type that are able to intercommunicate directly without the help of bridging or routing services. ( NAME 'cim22LANSegment' DESC 'A collection of LAN Endpoints of a particular type that are able to intercommunicate directly without the assistance of bridging or routing services.' SUP cim22LogicalNetwork MAY (cimLANID $ cimLANType $ cimOtherLANType) ) The following content rule specifies the auxiliary classes that may be attached to cim22LANSegment. ( NAME 'cim22LANSegmentContentRule' DESC 'The auxiliary classes that may be attached to cim22LANSegment' AUX (cim22InSegmentAuxClass) ) 3.12 cim22InLogicalNetworkAuxClass This auxiliary class defines a protocol endpoint as a member of a specific logical network. ( NAME 'cim22InLogicalNetworkAuxClass' DESC 'This association defines a ProtocolEndpoint as a member of Expires 6/30/00 [Page 14] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 a specific LogicalNetwork. Attribute cimCollectionRef points to cim22LogicalNetwork and attribute cimMemberRef points to cim22ProtocolEndpoint.' SUP cim22CollectedMSEsAuxClass AUXILIARY MAY (cimCollectionRef $ cimMemberRef) ) 3.13 cim22InSegmentAuxClass This auxiliary class defines a LAN endpoint as a member of a specific LAN segment. ( NAME 'cim22InSegmentAuxClass' DESC 'Defines a LANEndpoint as a member of a specific LANSegment. Attribute cimCollectionRef points to cim22LANSegment and attribute cimMemberRef points to cim22LANEndpoint.' SUP cim22InLogicalNetworkAuxClass AUXILIARY MAY (cimCollectionRef $ cimMemberRef) ) 3.14 cim22ActiveConnectionAuxClass This auxiliary class defines a connection that is currently carrying traffic between two protocol endpoints. ( NAME 'cimTrafficType' DESC 'The type of traffic that is carried over this connection' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOtherTrafficDescription' DESC 'A string describing the type of traffic that is being carried over this instance when its Type property is set to 1 (e.g., "Other"). The format of the string inserted in this property should be similar in format to the values defined for the Type property. This property should be set to NULL when the Type property is any value other than 1.' SYNTAX string{64} SINGLE-VALUE ) ( NAME 'cimIsUnidirectional' DESC 'TRUE means that this connection is uni-directional; FALSE means that this connection is bi-directional.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cim22ActiveConnectionAuxClass' Expires 6/30/00 [Page 15] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'This association defines a connection that is currently carrying traffic between two ProtocolEndpoints. Both reference attributes point to cim22ProtocolEndpoint objects.' SUP cim22SAPSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimTrafficType $ cimOtherTrafficDescription $ cimIsUnidirectional) ) 3.15 cim22IPAddressRange This class represents a grouping of specific addresses, and provides additional semantics for this group if appropriate. ( NAME 'cimStartAddress' DESC 'The starting IP address of the AddressRange, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., "171.79.6.40").' SYNTAX string SINGLE-VALUE ) ( NAME 'cimEndAddress' DESC 'The ending IP address of the AddressRange, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., "171.79.6.40").' SYNTAX string SINGLE-VALUE ) ( NAME 'cimTypeOfAddress' DESC 'An enumeration that defines how to format the address and mask of the address range that defines this IPSubnet).Whenever possible, IPv4-compatible addresses should be used instead of IPv6 addresses (see RFC 2373, section 2.5.4). In order to have a consistent format for IPv4 addresses in a mixed IPv4/v6 environment, all IPv4 addresses and both IPv4-compatible IPv6 addresses and IPv4-mapped IPv6 addresses, per RFC 2373, section 2.5.4, should be formatted in standard IPv4 format. However, this (the 2.2) version of the Network Common Model will not explicitly support mixed IPv4/IPv6 environments. This will be added in the 2.3 release.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimAllocationRegion' DESC 'This attribute defines the region that addresses can be allocated to.' SYNTAX integer SINGLE-VALUE ) Expires 6/30/00 [Page 16] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cim22IPAddressRange' DESC 'This represents a grouping of specific addresses, and provides additional semantics for this group if appropriate.' SUP cim22CollectionOfMSEs ABSTRACT MAY (cimStartAddress $ cimEndAddress $ cimTypeOfAddress $ cimAllocationRegion) ) 3.16 cim22IPProtocolEndpoint This class represents a protocol endpoint that is dedicated to running IP. ( NAME 'cimIPVersionSupport' DESC 'It is not possible to tell from the address alone if a given IPProtocolEndpoint can support IPv4 and IPv6, or just one of these. This property explicitly defines the support for different versions of IP that this IPProtocolEndpoint has. More implementation experience is needed in order to correctly model mixed IPv4/IPv6 networks; therefore, this version (2.2) of the Network Common Model will not support mixed IPv4/IPv6 environments. This will be looked at more in the 2.3 version.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22IPProtocolEndpoint' DESC 'A ProtocolEndpoint that is dedicated to running IP.' SUP cim22ProtocolEndpoint MAY (cimAddress $ cimSubnetMask $ cimAddressType $ cimIPVersionSupport) ) 3.17 cim22BGPProtocolEndpoint This class represents a protocol endpoint that is dedicated to running BGP. ( NAME 'cimIsEBGP' DESC 'A boolean that, when TRUE, signifies that this is an instance of the external version of BGP (FALSE is the internal version).' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimIsEBGPMultihop' DESC 'Normally, two routers running EBGP must be physically connected. This boolean, when TRUE, denotes a LOGICAL Expires 6/30/00 [Page 17] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 connection between two routers that are running EBGP (e.g., there is an intermediate router or interface between them.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimLocalIdentifier' DESC 'This is the unique identifier of the local BGP router. This is often the router ID (e.g., an IP address).' SYNTAX string SINGLE-VALUE ) ( NAME 'cimPeerIdentifier' DESC 'This is the unique identifier of the peer BGP router. This is often the router ID (e.g., an IP address).' SYNTAX string SINGLE-VALUE ) ( NAME 'cimState' DESC 'This defines the current connection state of the BGP Peer.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimAdminStatus' DESC 'This defines the desired state of the BGP connection.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimNegotiatedVersion' DESC 'This defines the negotiated version of BGP that is running between the two peers.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimLocalAddress' DESC 'This is the local IP address of this router's BGP connection.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimLocalPort' DESC 'This is the local port number for the TCP connection of this router's BGP connection.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimRemoteAddress' DESC 'This is the remote IP address of this router's BGP connection.' Expires 6/30/00 [Page 18] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 SYNTAX string SINGLE-VALUE ) ( NAME 'cimRemotePort' DESC 'This is the remote port number for the TCP connection of this router's BGP connection.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimRemoteAS' DESC 'This is the remote AS number for this router's BGP connection.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimHoldTime' DESC '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 this 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.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimKeepAlive' DESC 'This defines the time interval in seconds for the KeepAlive timer established with the peer. The value of this property is calculated by this 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.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22BGPProtocolEndpoint' DESC 'A ProtocolEndpoint that is dedicated to running BGP.' SUP cim22ProtocolEndpoint MAY (cimIsEBGP $ cimIsEBGPMultihop $ cimLocalIdentifier $ cimPeerIdentifier $ cimState $ cimAdminStatus $ cimNegotiatedVersion $ cimLocalAddress $ cimLocalPort $ Expires 6/30/00 [Page 19] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 cimRemoteAddress $ cimRemotePort $ cimRemoteAS $ cimHoldTime $ cimKeepAlive) ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPProtocolEndpoint. ( NAME 'cim22BGPProtocolEndpointContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPProtocolEndpoint' AUX (cim22RoutesBGPAuxClass $ cim22ASBGPEndpointsAuxClass) ) 3.18 cim22IPXProtocolEndpoint This class represents an IPX communication point from which data may be sent or received. ( NAME 'cim22IPXProtocolEndpoint' DESC 'An IPX communication point from which data may be sent or received.' SUP cim22ProtocolEndpoint MAY (cimAddress) ) 3.19 cim22IPXNetwork This class represents a network or subnet that uses the IPX protocol' ( NAME 'cimNetworkNumber' DESC 'An IPX network number formatted as eight hexadecimal digits (e.g., "00112233").' SYNTAX string SINGLE-VALUE ) ( NAME 'cim22IPXNetwork' DESC 'A network or subnet that uses the IPX protocol' SUP cim22LogicalNetwork MAY (cimNetworkNumber) ) 3.20 cim22IPRoute This class relates a remote IP address (destination) to a local IP address (source) through which the remote address may be reached. The local and remote addresses may be either specific IP endpoints or IP subnets. This class may used to represent a generic routing table entry. Expires 6/30/00 [Page 20] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimServiceCreationClassName' DESC 'The scoping Service's CreationClassName.' SYNTAX string{256} SINGLE-VALUE ) ( NAME 'cimServiceName' DESC 'The scoping Service's Name.' SYNTAX string{256} SINGLE-VALUE ) ( NAME 'cimIPDestinationAddress' DESC 'The IP address which serves as the destination of the traffic, formatted according to the appropriate convention as defined in the AddressType property of this class.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimIPDestinationMask' DESC 'The mask for the destination IP address, formatted according to the appropriate convention as defined in the AddressType property of this class.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimNextHop' DESC 'This contains either the address of the directly connected interface of the next-hop router or the address of the interface to which the destination is connected to.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimIsStatic' DESC 'TRUE indicates that this ProtocolEndpoint represents a static route, and FALSE means that it represents a dynamically-learned route.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cim22IPRoute' DESC 'An IPRoute relates a remote IP address (destination) to a local IP address (source) through which the remote address may be reached. The local and remote addresses may be either specific IP endpoints or IP subnets. This class may used to represent a generic routing table entry.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimServiceCreationClassName $ cimServiceName $ cimCreationClassName $ cimIPDestinationAddress $ Expires 6/30/00 [Page 21] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 cimIPDestinationMask $ cimNextHop $ cimAddressType) MAY (cimIsStatic) ) ( NAME 'cim22IPRouteNameForm' OC cim22IPRoute MUST (orderedCimModelPath) ) ( NAME 'cim22IPRouteStructureRule' FORM cim22IPRouteNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22IPRoute. ( NAME 'cim22IPRouteContentRule' DESC 'The auxiliary classes that may be attached to cim22IPRoute' AUX (cim22CalculatedRoutesAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) ) 3.21 cim22BindsToAuxClass This auxiliary class establishes a protocol endpoint on one system as a requestor of protocol services from another protocol endpoint on the same system. ( NAME 'cim22BindsToAuxClass' DESC 'This association establishes a ProtocolEndpoint on one system as a requestor of protocol services from another ProtocolEndpoint on the same system. This binding establishes a layering of two protocols, the upper layer represented by the Dependent (a cim22ProtocolEndpoint) and the lower layer represented by the Antecedent (a cim22ServiceAccessPoint).' SUP cim22SAPSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) Expires 6/30/00 [Page 22] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.22 cim22BindsToLANEdpointAuxClass This auxiliary class makes explicit the dependency of a protocol endpoint on some lower layer protocol endpoint on the same system. ( NAME 'cimFrameType' DESC 'This describes the framing method for the upper layer protocol endpoint that is bound to a LANEndpoint. Note: "Raw802.3" is only known to be used with the IPX protocol.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22BindsToLANEndpointAuxClass' DESC 'This association makes explicit the dependency of a ProtocolEndpoint on some lower layer ProtocolEndpoint on the same system. Attribute cimAntecedentRef points to cim22LANEndpoint and cimDependentRef points to cim22ProtocolEndpoint.' SUP cim22BindsToAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimFrameType) ) 3.23 cim22BGPIPRoute This class describes a BGP routing entry that connects two peer routers that are running BGP. The source and destination addresses may be either specific IP endpoints or IP subnets. ( NAME 'cimIsBackDoorRoute' DESC 'Usually, the administrative distance is used to determine which route gets installed in the routing table. Using this scheme, routes learned via EBGP will win over routes learned via an IGP. If this is not desired, then this assigns the administrative distance of this route to be equal to that of a local route, which means that the same route learned by an IGP will have a lower administrative distance and be installed instead.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimUsesLoopbackPeering' DESC 'Loopback interfaces are often used by IBGP peers, because they eliminate a dependency that would otherwise occur if the actual IP address of a physical interface was used to configure BGP. The loopback interface instead instructs the router to use any available interface.' SYNTAX boolean SINGLE-VALUE ) Expires 6/30/00 [Page 23] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cim22BGPIPRoute' DESC 'BGPIPRoute describes a BGP routing entry that connects two peer routers that are running BGP. The source and destination addresses may be either specific IP endpoints or IP subnets.' SUP cim22IPRoute MAY (cimIsBackDoorRoute $ cimUsesLoopbackPeering) ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPIPRoute. ( NAME 'cim22BGPIPRouteContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPIPRoute' AUX (cim22RoutesBGPAuxClass) ) 3.24 cim22RoutesBGPAuxClass This auxiliary class defines a BGP route, and makes explicit the dependency between a BGPIPRoute and a BGPProtocolEndpoint. ( NAME 'cim22RoutesBGPAuxClass' DESC 'This association defines a BGP route, and makes explicit the dependency between a BGPIPRoute and a BGPProtocolEndpoint. Attribute cimAntecedentRef points to cim22BGPProtocolEndpoint and attribute cimDependentRef points to cim22BGPIPRoute.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.25 cim22BGPCluster BGP speakers in an AS are required to be fully meshed. This can lead to a huge number of TCP connections per router. One way to reduce the peering requirements is to use a route reflector. This is based on specifying one or more routers to act as focal points for IBGP sessions. The route reflector as a whole is called a cluster. It is logically divided into three types of routers: reflectors, clients of the route reflector(s), and non-clients of the route reflector. An AS can have more than one route reflector. There can be more than one route reflector in a cluster, and there can be more than one cluster in an AS. ( NAME 'cimClusterID' DESC 'If a cluster has more than one route reflector, all of the Expires 6/30/00 [Page 24] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 route reflectors in the cluster need to be configured with a 4-byte cluster ID. This allows route reflectors to recognize updates from other route reflectors in the same cluster.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22BGPCluster' DESC 'The BGP speakers in an AS are required to be fully meshed. This can lead to a huge number of TCP connections per router. One way to reduce the peering requirements is to use a route reflector. This is based on specifying one or more routers to act as focal points for IBGP sessions. The route reflector as a whole is called a cluster. It is logically divided into three types of routers: reflectors, clients of the route reflector(s), and non-clients of the route reflector. An AS can have more than one route reflector. There can be more than one route reflector in a cluster, and there can be more than one cluster in an AS.' SUP cim22CollectionOfMSEs MUST (cimClusterID $ orderedCimModelPath) ) ( NAME 'cim22BGPClusterNameForm' OC cim22BGPCluster MUST (orderedCimModelPath) ) ( NAME 'cim22BGPClusterStructureRule' FORM cim22BGPClusterNameForm ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPCluster. ( NAME 'cim22BGPClusterContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPCluster' AUX (cim22RoutersInBGPClusterAuxClass $ cim22BGPClustersInASAuxClass $ cim22ReflectorServiceAuxClass $ cim22ReflectorClientServiceAuxClass $ cim22ReflectorNonClientServiceAuxClass $ cim22CollectedMSEsAuxClass $ cim22CollectedCollectionsAuxClass $ cim22CollectionConfigurationAuxClass $ cim22CollectionSettingAuxClass) ) Expires 6/30/00 [Page 25] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.26 cim22RoutersInBGPClusterAuxClass This auxiliary class establishes 'whole-part' relationships between a BGP cluster and the computer systems (e.g., the routers) that it contains. At least three routers are required to form a cluster - a reflector and two clients. In addition, the routers that form a cluster share common configuration information, and are commonly administered. ( NAME 'cim22RoutersInBGPClusterAuxClass' DESC 'This aggregation establishes "whole-part" relationships between a BGPCluster and the ComputerSystems (e.g., the routers) that it contains. At least three routers are required to form a cluster - a reflector and two clients. In addition, the routers that form a cluster share common configuration information, and are commonly administered. Attribute cimCollectionRef points to cim22BGPCluster and attribute cimMemberRef points to cim22ComputerSystem.' SUP cim22CollectedMSEsAuxClass AUXILIARY MAY (cimCollectionRef $ cimMemberRef) ) 3.27 cim22BGPClustersInASAuxClass This auxiliary class 'whole-part' relationships between an autonomous system and the BGP clusters that it contains. In addition, the routers that form a cluster share common configuration information, and are commonly administered. ( NAME 'cimGroupASRef' DESC 'The AutonomousSystem that aggregates the Clusters belonging to it and administers them.' SYNTAX DN ) ( NAME 'cimPartASRef' DESC 'The Clusters that are contained in the AS.' SYNTAX DN ) ( NAME 'cim22BGPClustersInASAuxClass' DESC 'This aggregation establishes "whole-part" relationships between an AutonomousSystem and the BGPClusters that it In addition, the routers that form a cluster share common configuration information, and are commonly administered. Attribute cimGroupASRef points to cim22AutonomousSystem and attribute cimPartASRef points to Expires 6/30/00 [Page 26] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 cim22BGPCluster.' SUP top AUXILIARY MAY (cimGroupASRef $ cimPartASRef) ) 3.28 cim22RoutersInASAuxClass This auxiliary class establishes 'whole-part' relationships between an AutonomousSystem and the routers that it contains. In addition, the routers in the AS share common configuration information, and are commonly administered. ( NAME 'cimBGPSupportedAttributes' DESC 'This is an array of strings that contain the BGP attributes supported by this router.' SYNTAX string ) ( NAME 'cimAddCommunityValue' DESC 'TRUE means that the community value of this router is added to the existing community value, and FALSE means that the community value of this router replaces the existing community value.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimRoleInteger' DESC 'This is an enumeration that defines the function, from the point of view of BGP, of this router.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOtherRoleDescription' DESC 'A string describing the type of function that this router has in its AS when the value of the Role property of this class is set to 1 (e.g., "Other"). The format of the string inserted in this property should be similar in format to the values defined for the Role property. This property should be set to NULL when the Role property is any value other than 1.' SYNTAX string{64} SINGLE-VALUE ) ( NAME 'cim22RoutersInASAuxClass' DESC 'This aggregation establishes "whole-part" relationships between an AutonomousSystem and the routers that it contains. In addition, the routers in the AS share common configuration information, and are commonly Expires 6/30/00 [Page 27] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 administered. Attribute cimGroupComponentRef points to cim22AutonomousSystem and attribute cimPartComponentRef points to cim22ComputerSystem.' SUP cim22SystemComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef $ cimBGPSupportedAttributes $ cimAddCommunityValue $ cimRoleInteger $ cimOtherRoleDescription) ) 3.29 cim22ProvidesEndpointAuxClass This auxiliary class shows that a protocol service provides endpoints to give access its services. ( NAME 'cim22ProvidesEndpointAuxClass' DESC 'A protocol service provides endpoints to give access its services. Attribute cimAntecedentRef points to cim22NetworkService and attribute cimDependentRef points to cim22ProtocolEndpoint.' SUP cim22ServiceAccessBySAPAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.30 cim22ASBGPEndpointsAuxClass This auxiliary class defines the different router interfaces that are running BGP in the autonomous system. ( NAME 'cim22ASBGPEndpointsAuxClass' DESC 'This aggregation defines the different router interfaces that are running BGP in the AutonomousSystem. Attribute cimGroupComponentRef points to cim22AutonomousSystem and attribute cimPartComponentRef points to cim22BGPProtocolEndpoint.' SUP cim22SystemComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.31 cim22ConfederationAuxClass The BGP speakers in an AS are required to be fully meshed. This can lead to a huge number of TCP connections per router. One way to reduce the peering requirements is to use a confederation. A confederation effectively partitions one AS into a group of 'sub- ASs'. This enables all the benefits of IBGP to be applied inside the confederation, while enabling EBGP to be run between each confederation. This enables certain BGP attribute values to be preserved between confederations. However, to the outside world, the Expires 6/30/00 [Page 28] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 AS with its confederations appear to be a single AS. ( NAME 'cimParentASNumber' DESC 'A unique identifier of the AutonomousSystem that contains the confederations.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimChildASNumber' DESC 'A unique identifier of the Confederation within the AutonomousSystem.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22ConfederationAuxClass' DESC 'The BGP speakers in an AS are required to be fully meshed. This can lead to a huge number of TCP connections per router. One way to reduce the peering requirements is to use a confederation. A confederation effectively partitions one AS into a group of "sub-ASs". This enables all of the benefits of IBGP to be applied inside the confederation, while enabling EBGP to be run between each confederation. This enables certain BGP attribute values to be preserved between confederations. However, to the outside world, the AS with its confederations appear to be a single AS. Both reference attributes point to cim22AutonomousSystem objects.' SUP cim22SystemComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef $ cimParentASNumber $ cimChildASNumber) ) 3.32 cim22RouteCalculationService This is a base class, derived from cim22NetworkService, that represents the route calculation aspects performed by a router. This also include functions performed by the router when it exchanges routing information. There are a large variety of additional routing protocols that are not listed below that will use this service. These will be added when they are modeled. ( NAME 'cimRouterID' DESC 'The RouterID uniquely identifies the router that is performing the route calculation. It is the highest IP address on the router (or the highest loopback interface, if there is one).' SYNTAX string SINGLE-VALUE ) Expires 6/30/00 [Page 29] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimTypeinteger' DESC 'This is an enumerated value that defines the routing algorithm used that this route calculation is being performed for.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22RouteCalculationService' DESC 'This is a concrete base class, derived from cim22NetworkService, that represents the route calculation aspects performed by a router. This also include functions performed by the router when it exchanges routing information. There are a large variety of additional routing protocols that are not listed below that will use this service. These will be added when they are modeled.' SUP cim22NetworkService MAY (cimRouterID $ cimTypeinteger) ) The following content rule specifies the auxiliary classes that may be attached to cim22RouteCalculationService. ( NAME 'cim22RouteCalculationServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22RouteCalculationService' AUX (cim22CalculatedRoutesAuxClass $ cim22EGPRouteCalcDependencyAuxClass $ cim22CalculatesAmongAuxClass) ) 3.33 cim22CalculatedRoutesAuxClass This auxiliary class makes explicit the routes that are calculated by a specific route calculation service. Thus, every route calculation service can have its own unique set of calculated routes. ( NAME 'cim22CalculatedRoutesAuxClass' DESC 'This assocation makes explicit the routes that are calculated by a specific RouteCalculationService. Thus, every RouteCalculationService can have its own unique set of calculated routes. Attribute cimAntecedentRef points to cim22RouteCalculationService and attribute cimDependentRef points to cim22IPRoute.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) Expires 6/30/00 [Page 30] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.34 cim22EGPRouteCalcDependencyAuxClass This is a specialization of cim22ServiceServiceDependencyAuxClass, and captures the dependency that external gateway protocols (such as BGP) have on interior gateway protocols (such as OSPF). ( NAME 'cimIGPInjection' DESC 'Sometimes it is necessary to inject EGP information, such as that from BGP, into IGPs. This attribute defines whether this should be done for the two routing protocols that are defined by this association. The values below mean that no, partial, and full EGP information is injected into the IGP, respectively.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22EGPRouteCalcDependencyAuxClass' DESC 'This is a specialization of cim22ServiceServiceDependency, and captures the dependency that external gateway protocols (such as BGP) have on interior gateway protocols (such as OSPF). Both reference attributes point to cim22RouteCalculationService objects.' SUP cim22ServiceServiceDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimIGPInjection) ) 3.35 cim22BGPService This class represents the basic operation of BGP. It is derived from cim22RouteCalculationService, the superclass of all routing protocols. ( NAME 'cimBGPVersion' DESC 'The BGPVersion property defines the version of BGP that this router is using. This is part of the BGP peer negotiation process).' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimLastMessageErrorSubCode' DESC 'This defines the BGP error subcode for message header errors. If the ErrorCode property is any other value, then this property should be set to NULL.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimLastOpenErrorSubCode' DESC 'This defines the BGP error subcode for OPEN message Expires 6/30/00 [Page 31] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 errors. If the ErrorCode property is any other value, then this property should be set to NULL.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimLastUpdateErrorSubCode' DESC 'This defines the BGP error subcode for UPDATE message errors. If the ErrorCode property is any other value, then this property should be set to NULL.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22BGPService' DESC 'This class is used to represent the basic operation of BGP. It is derived from RouteCalculationService, the superclass of all routing protocols.' SUP cim22RouteCalculationService MAY (cimBGPVersion $ cimLastErrorCode $ cimLastMessageErrorSubCode $ cimLastOpenErrorSubCode $ cimLastUpdateErrorSubCode) ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPService. ( NAME 'cim22BGPServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPService' AUX (cim22ReflectorServiceAuxClass $ cim22ReflectorClientServiceAuxClass $ cim22ReflectorNonClientServiceAuxClass $ cim22BGPRoutingPolicyAuxClass $ cim22BGPPeerGroupServiceAuxClass $ cim22BGPAdminDistanceAuxClass) ) 3.36 cim22BGPPeerGroup A BGP Peer Group is a set of BGP neighbors that share the same update policies. This enables an administrator to assign policies to the peer group, instead of individually. This enables the routers in the Peer Group to optimize UPDATE messages. Consequently, Peer Groups have a set of restrictions that must be followed to work correctly with external BGP peers. Otherwise, loss of routing information could occur. ( NAME 'cimConnectRetryInterval' DESC 'This defines the time interval, in seconds, for the ConnectRetry timer. The suggested value is 120 seconds.' Expires 6/30/00 [Page 32] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 SYNTAX integer SINGLE-VALUE ) ( NAME 'cimHoldTimeConfigured' DESC '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. This 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.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimKeepAliveConfigured' DESC '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.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimMinASOriginationInterval' DESC 'This defines the time interval in seconds for the MinASOriginationInterval timer. The suggested value for this property is 15 seconds.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimMinRouteAdvertisementInterval' DESC 'This defines the time interval in seconds for the MinRouteAdvertisementInterval timer. The suggested value for this property is 30 seconds.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22BGPPeerGroup' DESC 'A BGP Peer Group is a set of BGP neighbors that share the same update policies. This enables an administrator to Expires 6/30/00 [Page 33] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 assign policies to the peer group, instead of individually. This enables the routers in the Peer Group to optimize UPDATE messages. Consequently, Peer Groups have a set of restrictions that must be followed in order to work correctly with external BGP peers. Otherwise, loss of routing information could occur. A BGPPeerGroup is weak to the AutonomousSystem that contains it. Therefore, the keys from System must be propagated to it.' SUP cim22CollectionOfMSEs MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName $ orderedCimModelPath) MAY (cimConnectRetryInterval $ cimHoldTimeConfigured $ cimKeepAliveConfigured $ cimMinASOriginationInterval $ cimMinRouteAdvertisementInterval) ) ( NAME 'cim22BGPPeerGroupNameForm' OC cim22BGPPeerGroup MUST (orderedCimModelPath) ) ( NAME 'cim22BGPPeerGroupStructureRule' FORM cim22BGPPeerGroupNameForm ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPPeerGroup. ( NAME 'cim22BGPPeerGroupContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPPeerGroup' AUX (cim22BGPPeerGroupServiceAuxClass $ cim22BGPPeerUsesRouteMapAuxClass $ cim22InBGPPeerGroupAuxClass $ cim22CollectedMSEsAuxClass $ cim22CollectedCollectionsAuxClass $ cim22CollectionConfigurationAuxClass $ cim22CollectionSettingAuxClass) ) 3.37 cim22ReflectorServiceAuxClass This auxiliary class acts as the base for defining BGP routing policies for the reflector of this Cluster. ( NAME 'cim22ReflectorServiceAuxClass' DESC 'This association will serve as the base class for defining BGP routing policies for the reflector of this Cluster. Attribute cimAntecedentRef points to cim22BGPCluster Expires 6/30/00 [Page 34] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 and attribute cimDependentRef points to cim22BGPService.' SUP top AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.38 cim22ReflectorClientServiceAuxClass This auxiliary class acts as the base for defining BGP routing policies for clients of the reflector of this Cluster. ( NAME 'cim22ReflectorClientServiceAuxClass' DESC 'This association will serve as the base class for defining BGP routing policies for clients of the reflector of this Cluster. Attribute cimAntecedentRef points to cim22BGPCluster and attribute cimDependentRef points to cim22BGPService.' SUP top AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.39 cim22ReflectorNonClientServiceAuxClass This auxiliary class acts as the base for defining BGP routing policies for non-clients of the reflector of this Cluster. ( NAME 'cim22ReflectorNonClientServiceAuxClass' DESC 'This association will serve as the base class for defining BGP routing policies for the non-clients of the reflector of this Cluster. Attribute cimAntecedentRef points to cim22BGPCluster attribute cimDependentRef points to cim22BGPService.' SUP top AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.40 cim22FilterEntry This class is used by network devices to identify traffic and either forward them (with possibly further processing) to their destination, or to deny their forwarding. They are the building block of FilterLists. ( NAME 'cimMatchConditionType' DESC 'This specifies one of a set of ways to identify traffic. if the value is 1 (e.g., "Other"), then the specific type of filtering is specified in the OtherMatchConditionType property of this class.' SYNTAX integer SINGLE-VALUE Expires 6/30/00 [Page 35] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ) ( NAME 'cimOtherMatchConditionType' DESC 'If the value of the MatchConditionType property in this class is 1 (e.g., "Other"), then the specific type of filtering is specified in this property.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimMatchConditionValue' DESC 'This is the value of the condition that filters the traffic. It corresponds to the condition specified in the MatchConditionType property. If, however, the value of the MatchConditionProperty is 1, then it corresponds to the condition specified in the OtherMatchConditionType property.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimAction' DESC 'This defines whether the action should be to forward or deny traffic meeting the match condition specified in this filter.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22FilterEntry' DESC 'A FilterEntry is used by network devices to identify traffic and either forward them (with possibly further processing) to their destination, or to deny their forwarding. They are the building block of FilterLists.A FilterEntry is weak to the network device (e.g., the ComputerSystem) that contains it. Hence, the ComputerSystem keys are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName) MAY (cimTrafficType $ cimMatchConditionType $ cimOtherMatchConditionType $ cimMatchConditionValue $ cimAction) ) ( NAME 'cim22FilterEntryNameForm' OC cim22FilterEntry MUST (orderedCimModelPath) ) ( NAME 'cim22FilterEntryStructureRule' FORM cim22FilterEntryNameForm Expires 6/30/00 [Page 36] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22FilterEntry. ( NAME 'cim22FilterEntryContentRule' DESC 'The auxiliary classes that may be attached to cim22FilterEntry' AUX (cim22EntriesInFilterListAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.41 cim22FilterList This class is used by network devices to identify routes by aggregating a set of FilterEntries into a unit, called a FilterList. FilterLists can also be used to accept or deny routing updates. Since a FilterList is weak to the network device (e.g., the ComputerSystem) that contains it, DIT structural rules are also specified.' ( NAME 'cim22FilterList' DESC 'A FilterList is used by network devices to identify routes by aggregating a set of FilterEntries into a unit, called a FilterList. FilterLists can also be used to accept or deny routing updates. A FilterList is weak to the network device (e.g., the ComputerSystem) that contains it. Hence, the ComputerSystem keys are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName) MAY (cimDirection) ) ( NAME 'cim22FilterListNameForm' OC cim22FilterList MUST (orderedCimModelPath) ) ( NAME 'cim22FilterListStructureRule' FORM cim22FilterListNameForm SUP ) Expires 6/30/00 [Page 37] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 The following content rule specifies the auxiliary classes that may be attached to cim22FilterList. ( NAME 'cim22FilterListContentRule' DESC 'The auxiliary classes that may be attached to cim22FilterList' AUX (cim22EntriesInFilterListAuxClass $ cim22ListsInRoutingPolicyAuxClass $ cim22FilterListsInBGPRouteMapAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.42 cim22RoutingPolicy This class implements routing policies. It aggregates a set of FilterLists, along with other appropriate constructs, into a unit. A most important use of this class is to change the routing policy by changing values of various BGP attributes in a consistent manner. Since a RoutingPolicy is weak to the network device (e.g., the ComputerSystem) that contains it, DIT structural rules are also specified. ( NAME 'cimBGPAction' DESC 'This defines one or more BGP attributes that should be used to modify this routing update.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBGPValue' DESC 'The value for the corresponding BGPAction.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimRemarkAction' DESC 'This defines a remarking action for this traffic.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimRemarkValue' DESC 'The value for the corresponding RemarkAction.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimConditioningAction' Expires 6/30/00 [Page 38] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'This defines other actions to be taken for this traffic.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOtherConditioningAction' DESC 'If the value of the ConditioningAction property of this class is 1, this contains an application-specific type of conditioning that is to be performed. Otherwise, if the ConditioningAction property is any other value, the value of this property should be NULL.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimConditioningValue' DESC 'The value for the corresponding ConditioningAction.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimAttributeAction' DESC 'This controls whether BGP attribute values replace, get prepended, or get appended to their existing values.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22RoutingPolicy' DESC 'This class is used to implement routing policies. It aggregates a set of FilterLists, along with other appropriate constructs, into a unit. One of the most important uses of this class is to change the routing policy by changing values of various BGP attributes in a consistent manner. A RoutingPolicy is weak to the network device (e.g., the ComputerSystem) that contains it. Hence, the ComputerSystem keys are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName) MAY (cimDescription $ cimAction $ cimBGPAction $ cimBGPValue $ cimRemarkAction $ cimRemarkValue $ cimConditioningAction $ cimOtherConditioningAction $ cimConditioningValue $ cimAttributeAction) ) ( NAME 'cim22RoutingPolicyNameForm' OC cim22RoutingPolicy MUST (orderedCimModelPath) ) ( NAME 'cim22RoutingPolicyStructureRule' Expires 6/30/00 [Page 39] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 FORM cim22RoutingPolicyNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22RoutingPolicy. ( NAME 'cim22RoutingPolicyContentRule' DESC 'The auxiliary classes that may be attached to cim22RoutingPolicy' AUX (cim22ListsInRoutingPolicyAuxClass $ cim22BGPRoutingPolicyAuxClass $ cim22BGPRouteMapsInRoutingPolicyAuxClass $ cim22FilteredBGPAttributesAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.43 cim22EntriesInFilterListAuxClass This is a specialization of cim22ComponentAuxClass that defines a set of filter entries that are aggregated by a particular filter list. ( NAME 'cimSequence' DESC 'the position of the FilterEntry relative to all other entries in the FilterList.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22EntriesInFilterListAuxClass' DESC 'This is a specialization of the cim22Component aggregation which is used to define a set of FilterEntries that are aggregated by a particular FilterList. Attribute cimGroupComponentRef points to cim22FilterList and attribute cimPartComponentRef points to cim22FilterEntry.' SUP cim22ComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef $ cimSequence) ) 3.44 cim22ListsInRoutingPolicyAuxClass This is a specialization of the cim22ComponentAuxClass that defines a set of filter lists that are aggregated by a particular routing policy. Expires 6/30/00 [Page 40] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cim22ListsInRoutingPolicyAuxClass' DESC 'This is a specialization of the cim22Component aggregation which is used to define a set of FilterLists that are aggregated by a particular RoutingPolicy. Attribute cimGroupComponentRef points to cim22RoutingPolicy and attribute cimPartComponentRef points to cim22FilterList.' SUP cim22ComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef $ cimSequence) ) 3.45 cim22BGPRoutingPolicyAuxClass This is a specialization of the cim22DependencyAuxClass, and defines the relationship between a BGP service and the routing policy that control it. ( NAME 'cim22BGPRoutingPolicyAuxClass' DESC 'This is a specialization of the Dependency association, and defines the relationship between a BGPService and the RoutingPolicy that control it. Attribute cimAntecedentRef points to cim22RoutingPolicy and attribute cimDependentRef points to cim22BGPService.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.46 cim22BGPPeerGroupServiceAuxClass This auxiliary class defines the relationship between a BGPService and the BGP Peer Group that hosts it. ( NAME 'cim22BGPPeerGroupServiceAuxClass' DESC 'This defines the relationship between a BGPService and the BGP Peer Group that hosts it. Attribute cimAntecedentRef points to cim22BGPPeerGroup and attribute cimDependentRef points to cim22BGPService.' SUP top AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.47 cim22AdministrativeDistance This class controls the choosing of which protocol to give preference over when two protocols learn the same route. This preference parameter is called the distance of the protocol. The lower the distance, the higher the preference for that protocol. This table affects ALL routes. Expires 6/30/00 [Page 41] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimDirectConnect' DESC 'The distance for directly connected peers. It has a default value of 0.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimStatic' DESC 'The distance for staticly connected peers. It has a default value of 1.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimEBGP' DESC 'The distance for peers using EBGP. It has a default value of 20.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimEIGRPInternal' DESC 'The distance for peers using internal EIGRP. It has a default value of 90.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimIGRP' DESC 'The distance for peers using IGRP. It has a default value of 100.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOSPF' DESC 'The distance for peers using OSPF. It has a default value of 110.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimISIS' DESC 'The distance for peers using ISIS. It has a default value of 115.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimRIP' DESC 'The distance for peers using RIP. It has a default value of 120.' SYNTAX integer SINGLE-VALUE ) Expires 6/30/00 [Page 42] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimEGP' DESC 'The distance for peers using EGP. It has a default value of 140.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimEIGRPExternal' DESC 'The distance for peers using external EIGRP. It has a default value of 170.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimIBGP' DESC 'The distance for peers using IBGP. It has a default value of 200.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBGPLocal' DESC 'The distance for peers using BGP locally. It has a default value of 200.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimUnknown' DESC 'The distance for peers using an unknown protocol. It has a default value of 255.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22AdministrativeDistance' DESC 'This class is used to control the choosing of which protocol to give preference over when two protocols learn the same route. This preference parameter is called the distance of the protocol. The lower the distance, the higher the preference for that protocol. This table affects ALL routes. AdministrativeDistance, being a global object, is weak to the AdminDomain that contains it. Hence, the AdminDomain keys are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName) MAY (cimDirectConnect $ cimStatic $ cimEBGP $ cimEIGRPInternal $ cimIGRP $ cimOSPF $ cimISIS $ cimRIP $ cimEGP $ cimEIGRPExternal $ cimIBGP $ cimBGPLocal $ cimUnknown) ) ( NAME 'cim22AdministrativeDistanceNameForm' Expires 6/30/00 [Page 43] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 OC cim22AdministrativeDistance MUST (orderedCimModelPath) ) ( NAME 'cim22AdministrativeDistanceStructureRule' FORM cim22AdministrativeDistanceNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22AdministrativeDistance. ( NAME 'cim22AdministrativeDistanceContentRule' DESC 'The auxiliary classes that may be attached to cim22AdministrativeDistance' AUX (cim22BGPAdminDistanceAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.48 cim22BGPAdminDistanceAuxClass This is a specialization of cim22DependencyAuxClass and defines the relationship between a BGPService and the Administrative Distances that it uses to control the (BGP) routing decisions that it makes. ( NAME 'cim22BGPAdminDistanceAuxClass' DESC 'This is a specialization of the Dependency association, and defines the relationship between a BGPService and the Administrative Distances that it uses to control the (BGP) routing decisions that it makes. Attribute cimAntecedentRef points to cim22AdministrativeDistance and attribute cimDependentRef points to cim22BGPService.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.49 cim22BGPRouteMap A route map controls and changes routing information as well as to define when a route is redistributed between routing domains. Route maps are placed in router configuration files, and several instances of the same route map may be used to implement different actions (see accompanying white paper). Route maps may use FilterLists to identify Expires 6/30/00 [Page 44] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 the route (again, see the accompanying white paper). This object is specific to a given AutonomousSystem that contains it. Hence, DIT structural rules are included. ( NAME 'cimSetMetricType' DESC 'This defines an additional action to take if the MatchCondition is satisfied. This definition is specifically limited to BGP filtering for now (e.g., its use is limited to setting a BGP attribute to a specific value), and will be upgraded in a subsequent release. The actual value of the metric is specified in the SetMetricValue property.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimSetMetricValue' DESC 'This is the value of the metric that is being set for the BGP attribute defined in the SetMetricType property.' SYNTAX string SINGLE-VALUE ) ( NAME 'cim22BGPRouteMap' DESC 'A route map is used to control and modify routing information as well as to define when a route is redistributed between routing domains. Route maps are placed in router configuration files, and several instances of the same route map may be used to implement different actions (see accompanying white paper). Route maps may use FilterLists to identify the route (again, see the accompanying white paper). A BGPRouteMap is specific to a given AutonomousSystem that contains it. Hence, the keys of the AutonomousSystem are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimCreationClassName $ cimName) MAY (cimDirection $ cimAction $ cimMatchConditionType $ cimOtherMatchConditionType $ cimSetMetricType $ cimSetMetricValue) ) ( NAME 'cim22BGPRouteMapNameForm' OC cim22BGPRouteMap MUST (orderedCimModelPath) ) ( NAME 'cim22BGPRouteMapStructureRule' FORM cim22BGPRouteMapNameForm SUP Expires 6/30/00 [Page 45] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPRouteMap. ( NAME 'cim22BGPRouteMapContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPRouteMap' AUX (cim22BGPRouteMapsInRoutingPolicyAuxClass $ cim22BGPPeerUsesRouteMapAuxClass $ cim22FilterListsInBGPRouteMapAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.50 cim22BGPRouteMapsInRoutingPolicyAuxClass This auxiliary class defines the RouteMaps that are used by a particular RoutingPolicy object. Multiple instances of the same RouteMap may be used in the same RoutingPolicy instance; if this is desired, then the Sequence attribute of this aggregation can be used to disambiguate them. ( NAME 'cim22BGPRouteMapsInRoutingPolicyAuxClass' DESC 'This aggregation defines the RouteMaps that are used by a particular RoutingPolicy object. Multiple instances of the same RouteMap may be used in the same RoutingPolicy instance; if this is desired, then the Sequence attribute of this aggregation can be used to disambiguate them. Attribute cimGroupComponentRef points to cim22RoutingPolicy and attribute cimPartComponentRef points to cim22BGPRouteMap.' SUP cim22ComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef $ cimSequence) ) 3.51 cim22BGPPeerUsesRouteMapAuxClass This auxiliary class defines the RouteMaps that are used by a particular BGPPeerGroup object. Multiple instances of the same RouteMap may be used in the same BGPPeerGroup instance; if this is desired, then the Sequence attribute of this association can be used to disambiguate them. ( NAME 'cim22BGPPeerUsesRouteMapAuxClass' Expires 6/30/00 [Page 46] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'This association defines the RouteMaps that are used by a particular BGPPeerGroup object. Multiple instances of the same RouteMap may be used in the same BGPPeerGroup instance; if this is desired, then the Sequence attribute of this association can be used to disambiguate them. Attribute cimAntecedentRef points to cim22BGPPeerGroup and attribute cimDependentRef points to cim22BGPRouteMap.' SUP top AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimSequence) ) 3.52 cim22FilterListInBGPRouteMapAuxClass While route maps do not have to use filter lists, this auxiliary class defines that filter list that is used by a particular route map. ( NAME 'cim22FilterListsInBGPRouteMapAuxClass' DESC 'RouteMaps do not have to use FilterLists, but if they do, this association defines which FilterList is used by a particular RouteMap. Attribute cimAntecedentRef points to cim22FilterList and attribute cimDependentRef points to cim22BGPRouteMap.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.53 cim22InBGPPeerGroupAuxClass This auxiliary class defines the specific routers (e.g., ComputerSystems) that participate in a PeerGroup. ( NAME 'cim22InBGPPeerGroupAuxClass' DESC 'This aggregation defines the specific routers (e.g., ComputerSystems) that participate in a PeerGroup. Attribute cimCollectionRef points to cim22BGPPeerGroup and attribute cimMemberRef points to cim22ComputerSystem.' SUP cim22CollectedMSEsAuxClass AUXILIARY MAY (cimCollectionRef $ cimMemberRef) ) 3.54 cim22CalculatesAmongAuxClass This is a specialization of cim22ServiceSAPDependencyAuxClass, indicating that the referenced ProtocolEndpoint is utilized by the RouteCalculationService to provide its functionality. Expires 6/30/00 [Page 47] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cim22CalculatesAmongAuxClass' DESC 'This is a specialization of the ServiceSAPDependency association, indicating that the referenced ProtocolEndpoint is utilized by the RouteCalculationService to provide its functionality. Attribute cimAntecedentRef points to cim22ProtocolEndpoint and attribute cimDependentRef points to cim22RouteCalculationService.' SUP cim22ServiceSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimIsStatic) ) 3.55 cim22BGPAttributes This class defines all the BGP Attributes, for a given version of the BGP protocol, that can be used to affect routing decisions. BGPAttributes are specific to a given AutonomousSystem that contains it. Hence, DIT structural rules are recommended. ( NAME 'cimLocalPreference' DESC 'This defines the priority, or preference, of a route, in order to better compare it with other routes for the same destination. Higher values indicate a higher preference for a route.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimASPath' DESC 'This attribute is a sequences of the AS numbers through which routing information carried in this UPDATE message has passed. The components of this list can be AS_SETs or AS_SEQUENCEs.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimASSet' DESC 'This is the set of all elements contained in all specific paths that are being summarized, so that those attributes will remain available to the routing decision process.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimNextHopSelf' DESC 'This defines the next hop to be the IP address of the border IBGP neighbor.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimMED' Expires 6/30/00 [Page 48] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'This is used on external (e.g., inter-AS) links to indicate which is the preferred entry point into an AS, when that AS has multiple entry points. Lower MED values have preference.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBGPCommunityValue' DESC 'This defines a group of destinations that share a similar property. Communities are not restricted to a single AS, and can span multiple ASs. This attribute is used to simplify routing policies by basing policies on a logical value, as opposed to an IP address or an AS number. ' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimAtomicAggregate' DESC 'This attribute gets set if there are overlapping routes, and a less-specific route is selected instead of a more specific one (e.g., a system propagates an aggregate that causes loss of information.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimAggregator' DESC 'This specifies the AS and IP address of the router that has generated an aggregate.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimOrigin' DESC 'This is generated by the AS that originates the routing information. There are three types of origins - IGP, EGP, and INCOMPLETE. These correspond to whether the information was learned internally in the AS, externally via an EGP, or by some other means.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimOriginatorID' DESC 'This is the router ID for the ORIGIN attribute.' SYNTAX string SINGLE-VALUE ) ( NAME 'cim22BGPAttributes' DESC 'This class defines all of the BGP Attributes, for a given version of the BGP protocol, that can be used to affect routing decisions. BGPAttributes are specific to a given AutonomousSystem that contains it. Hence, the keys of the Expires 6/30/00 [Page 49] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 AutonomousSystem are propagated to this class.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimVersion) MAY (cimLocalPreference $ cimASPath $ cimASSet $ cimNextHop $ cimNextHopSelf $ cimMED $ cimBGPCommunityValue $ cimAtomicAggregate $ cimAggregator $ cimOrigin $ cimOriginatorID) ) ( NAME 'cim22BGPAttributesNameForm' OC cim22BGPAttributes MUST (orderedCimModelPath) ) ( NAME 'cim22BGPAttributesStructureRule' FORM cim22BGPAttributesNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22BGPAttributes. ( NAME 'cim22BGPAttributesContentRule' DESC 'The auxiliary classes that may be attached to cim22BGPAttributes' AUX (cim22FilteredBGPAttributesAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.56 cim22FilteredBGPAttributesAuxClass This is a specialization of cim22ComponentAuxClass, which defines the set of BGP Attributes that are used by a particular Routing Policy. ( NAME 'cim22FilteredBGPAttributesAuxClass' DESC 'This is a specialization of the Component aggregation, which is used to define the set of BGP Attributes that are used by a particular Routing Policy. Attribute cimGroupComponentRef points to cim22RoutingPolicy and attribute cimPartComponentRef points to cim22BGPAttributes.' SUP cim22ComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) Expires 6/30/00 [Page 50] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 3.57 cim22SwitchService Generic switch (bridging) service class. Additional switching functions are incorporated as subordinate services related to this class via ServiceComponent associations. ( NAME 'cim22SwitchService' DESC 'Generic switch (bridging) service class. Additional switching functions are incorporated as subordinate services related to this class via ServiceComponent associations.' SUP cim22ForwardingService ) The following content rule specifies the auxiliary classes that may be attached to cim22SwitchService. ( NAME 'cim22SwitchServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22SwitchService' AUX (cim22SwitchesAmongAuxClass $ cim22SwitchServiceTransparentBridgingAuxClass $ cim22SwitchServiceSpanningTreeAuxClass $ cim22SwitchServiceSourceRoutingAuxClass $ cim22SwitchServiceVLANAuxClass) ) 3.58 cim22SwitchPort A switch port from which frames are received and out they are transmitted. ( NAME 'cimPortNumber' DESC 'Numeric identifier for a switch port.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22SwitchPort' DESC 'Switch Port from which frames are received and out which they are transmitted.' SUP cim22ProtocolEndpoint MAY (cimPortNumber) ) The following content rule specifies the auxiliary classes that may be attached to cim22SwitchPort. ( NAME 'cim22SwitchPortContentRule' Expires 6/30/00 [Page 51] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'The auxiliary classes that may be attached to cim22SwitchPort' AUX (cim22SwitchesAmongAuxClass $ cim22SwitchableAuxClass $ cim22SwitchPortSpanningTreeAuxClass $ cim22SwitchPortDynamicForwardingAuxClass $ cim22SwitchPortStaticForwardingAuxClass $ cim22SwitchPortPairAuxClass $ cim22SwitchPortSourceRoutingAuxClass $ cim22InboundVLANAuxClass $ cim22OutboundVLANAuxClass) ) 3.59 cim22SwitchesAmongAuxClass A SwitchService switches frames between SwitchPorts. This auxiliary class makes that relationship explicit. ( NAME 'cim22SwitchesAmongAuxClass' DESC 'A SwitchService switches frames between SwitchPorts. This association makes that relationship explicit. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22SwitchService.' SUP cim22ForwardsAmongAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.60 cim22SwitchableAuxClass A switch port has a LANEndpoint that is exposed via this auxiliary class. ( NAME 'cim22SwitchableAuxClass' DESC 'A switch port has a LANEndpoint that is exposed via this relationship. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22LANEndpoint.' SUP cim22BindsToAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.61 cim22TransparentBridgingService This service class represents the learning/transparent bridging aspect of switch service. ( NAME 'cimAgingTime' DESC 'The timeout period in seconds for aging out dynamically learned forwarding information. 802.1D-1990 recommends a default of 300 seconds.' Expires 6/30/00 [Page 52] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 SYNTAX integer SINGLE-VALUE ) ( NAME 'cimFID' DESC 'Filtering Database Identifier. Used by VLAN-aware switch having more than one filtering database.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22TransparentBridgingService' DESC 'This service class represents the learning/transparent bridging aspect of switch service.' SUP cim22Service MAY (cimAgingTime $ cimFID) ) ( NAME 'cim22TransparentBridigingServiceNameForm' OC cim22TransparentBridigingService MUST (orderedCimModelPath) ) ( NAME 'cim22TransparentBridigingServiceStructureRule' FORM cim22TransparentBridigingServiceNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22TransparentBridgingService. ( NAME 'cim22TransparentBridgingServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22TransparentBridgingService' AUX (cim22SwitchServiceTransparentBridgingAuxClass $ cim22RelatedTransparentBridgingServiceAuxClass $ cim22RelatedSpanningTreeAuxClass) ) 3.62 cim22SpanningTreeService This class represents the capability of a switch to participate in the distributed construction of a spanning tree. ( NAME 'cimProtocolSpec' DESC 'The version of the spanning tree protocol used by the switch.' SYNTAX integer SINGLE-VALUE ) Expires 6/30/00 [Page 53] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 ( NAME 'cimPriority' DESC 'Priority indicates the urgency or importance of execution of a Process. If a priority is not defined for a Process, a value of 0 should be used.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimDesignatedRoot' DESC 'The Bridge ID (Priority + MAC Address) of the root bridge. The format of the priority bits are the first two octets of the 8-octet long Bridge ID. The other (last) 6 octets of the Bridge ID are given by the value of the Bridge Address. Note that the MAC address is formatted as twelve hexadecimal digits (e.g., "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order according to RFC 2469.' SYNTAX string{16} SINGLE-VALUE ) ( NAME 'cimRootCost' DESC 'The cost of the path from the switch to the root.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimRootPort' DESC 'The port number of the port having the lowest cost path to the root bridge.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimMaxAge' DESC 'The current value for the maximum age of Spanning Tree information before discard, as learned from the network.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimHelloTime' DESC 'The current value of the interval between transmission of bridge PDUs by the switch on any port for which it is the spanning tree root or trying to become so, as learned from the network.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimForwardDelay' DESC 'The time spent by a port in the listening state before transitioning to the learning state and in the learning state before transitioning to the forwarding state, as Expires 6/30/00 [Page 54] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 learned from the network. This value is also used during the period of a topology change as the maximum age of Spanning Tree information before discard.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBridgeMaxAge' DESC 'The MaxAge parameter to be used by all switches in the network if this switch becomes the root.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBridgeHelloTime' DESC 'The HelloTime parameter to be used by all switches in the network if this switch becomes the root.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBridgeForwardDelay' DESC 'The ForwardDelay parameter to be used by all switches in the network if this switch becomes the root.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimSpanningTreeBridgeAddress' DESC 'MAC address used by the spanning tree service when it must be uniquely identified. When concatenated with a SpanningTreeService Priority, a unique bridge identifier results. This property is defined for use of switches supporting multiple spanning tree services. Note that the MAC address is formatted as twelve hexadecimal digits (e.g., "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order according to RFC 2469.' SYNTAX string SINGLE-VALUE ) ( NAME 'cim22SpanningTreeService' DESC 'This service class represents the capability of a switch to participate in the distributed construction of a spanning tree.' SUP cim22Service MAY (cimProtocolSpec $ cimPriority $ cimDesignatedRoot $ cimRootCost $ cimRootPort $ cimMaxAge $ cimHelloTime $ cimHoldTime $ cimForwardDelay $ cimBridgeMaxAge $ cimBridgeHelloTime $ cimBridgeForwardDelay $ cimSpanningTreeBridgeAddress) ) Expires 6/30/00 [Page 55] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 The following content rule specifies the auxiliary classes that may be attached to cim22SpanningTreeService. ( NAME 'cim22SpanningTreeServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22SpanningTreeService' AUX (cim22SwitchPortSpanningTreeAuxClass $ cim22SwitchServiceSpanningTreeAuxClass $ cim22RelatedSpanningTreeAuxClass) ) 3.63 cim22SwitchPortSpanningTreeAuxClass A switch participating in the spanning tree maintains spanning-tree specific information about each port whose forwarding is determined by the spanning tree. This auxiliary class represents that information. ( NAME 'cimEnable' DESC 'The enabled/disabled status of the port.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimPathCost' DESC 'The contribution of this port to the path cost of paths towards the spanning tree root which include this port.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimDesignatedCost' DESC 'The cost of the path to the root offered by the designated bridge for the segment.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimDesignatedBridge' DESC 'The bridge identifier of the designated bridge for the segment to which the port is attached.' SYNTAX string SINGLE-VALUE ) ( NAME 'cimDesignatedPort' DESC 'The port identifier of the port on the designated bridge serving the segment to which the port is attached.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22SwitchPortSpanningTreeAuxClass' Expires 6/30/00 [Page 56] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'A switch participating in the spanning tree maintains spanning-tree specific information about each port whose forwarding is determined by the spanning tree. This association represents that information. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22SpanningTreeService.' SUP cim22ServiceSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimPriority $ cimState $ cimEnable $ cimPathCost $ cimDesignatedRoot $ cimDesignatedCost $ cimDesignatedBridge $ cimDesignatedPort) ) 3.64 cim22DynamicForwardingEntry This class represents an entry in the forwarding (filtering) database associated with the transparent bridging service. ( NAME 'cimDynamicStatus' DESC 'The status of the entry.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22DynamicForwardingEntry' DESC 'A DynamicForwardingEntry represents an entry in the forwarding (filtering) database associated with the transparent bridging service.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimServiceCreationClassName $ cimServiceName $ cimCreationClassName $ cimMACAddress) MAY (cimDynamicStatus) ) ( NAME 'cim22DynamicForwardingEntryNameForm' OC cim22DynamicForwardingEntry MUST (orderedCimModelPath) ) ( NAME 'cim22DynamicForwardingEntryStructureRule' FORM cim22DynamicForwardingEntryNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22DynamicForwardingEntry. ( NAME 'cim22DynamicForwardingEntryContentRule' DESC 'The auxiliary classes that may be attached to Expires 6/30/00 [Page 57] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 cim22DynamicForwardingEntry' AUX (cim22SwitchPortDynamicForwardingAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.65 cim22SwitchPortDynamicForwardingAuxClass This auxiliary class links a dynamic forwarding entry and the switch port to which the entry applies. ( NAME 'cim22SwitchPortDynamicForwardingAuxClass' DESC 'This association links a dynamic forwarding entry and the switch port to which the entry applies. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22DynamicForwardingEntry.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.66 cim22StaticForwardingEntry ( NAME 'cimStaticStatus' DESC 'The status of the entry.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimAllowedToGo' DESC 'The ports to which frames with the destination MAC address arriving on the port represented by the SwitchPortStaticForwarding association are allowed to be forwarded.' SYNTAX integer ) ( NAME 'cim22StaticForwardingEntry' DESC 'A StaticForwardingEntry represents an entry in the static (destination-address filtering) database associated with the switch service.' SUP cim22LogicalElement MUST (cimSystemCreationClassName $ cimSystemName $ cimServiceCreationClassName $ cimServiceName $ cimCreationClassName $ cimMACAddress) Expires 6/30/00 [Page 58] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 MAY (cimStaticStatus $ cimAllowedToGo) ) ( NAME 'cim22StaticForwardingEntryNameForm' OC cim22StaticForwardingEntry MUST (orderedCimModelPath) ) ( NAME 'cim22StaticForwardingEntryStructureRule' FORM cim22StaticForwardingEntryNameForm SUP ) The following content rule specifies the auxiliary classes that may be attached to cim22StaticForwardingEntry. ( NAME 'cim22StaticForwardingEntryContentRule' DESC 'The auxiliary classes that may be attached to cim22StaticForwardingEntry' AUX (cim22SwitchPortStaticForwardingAuxClass $ cim22LogicalIdentityAuxClass $ cim22CollectedMSEsAuxClass $ cim22ElementConfigurationAuxClass $ cim22ElementSettingAuxClass $ cim22DependencyAuxClass $ cim22ProvidesServiceToElementAuxClass $ cim22ComponentAuxClass $ cim22SystemComponentAuxClass $ cim22ActsAsSpareAuxClass) ) 3.67 cim22SwitchPortStaticForwardingAuxClass This auxiliary class links a static database entry and the switch port to which the entry applies. ( NAME 'cim22SwitchPortStaticForwardingAuxClass' DESC 'This association links a static database entry and the switch port to which the entry applies. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22StaticForwardingEntry.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.68 cim22ServiceComponentAuxClass This auxiliary class models a set of subordinate Services that are aggregated together to form a higher-level service. ( NAME 'cim22ServiceComponentAuxClass' Expires 6/30/00 [Page 59] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'The ServiceComponent aggregation models a set of subordinate Services that are aggregated together to form a higher-level service. Both reference attributes point to cim22Service objects.' SUP cim22ComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.69 cim22SwitchServiceTransparentBridgingAuxClass This auxiliary class links SwitchService to a component TransparentBridgingService. The cardinality of the TransparentBridgingService is 0.1 for a VLAN-unaware switch. ( NAME 'cim22SwitchServiceTransparentBridgingAuxClass' DESC 'An association linking SwitchService to a component TransparentBridgingService. The cardinality of the TransparentBridgingService is 0..1 for a VLAN-unaware switch. Attribute cimGroupComponentRef points to cim22SwitchService and attribute cimPartComponentRef points to cim22TransparentBridgingService.' SUP cim22ServiceComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.70 cim22SwitchServiceSpanningTreeAuxClass An auxiliary class that links SwitchService to a component SpanningTreeService. The cardinality of the SpanningTreeService is 0.1 for a VLAN-unaware switch. ( NAME 'cim22SwitchServiceSpanningTreeAuxClass' DESC 'An association linking SwitchService to a component SpanningTreeService. The cardinality of the SpanningTreeService is 0..1 for a VLAN-unaware switch. Attribute cimGroupComponentRef points to cim22SwitchService and attribute cimPartComponentRef points to cim22SpanningTreeService.' SUP cim22ServiceComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.71 cim22SourceRoutingService This service class represents the capability of a switch to participate in the source routing of frames received at its ports. ( NAME 'cimBridgeLfMode' Expires 6/30/00 [Page 60] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 DESC 'Indicates whether the bridge operates using older 3 bit length negotiation fields or the newer 6 bit length field in its RIF.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22SourceRoutingService' DESC 'This service class represents the capability of a switch to participate in the source routing of frames received at its ports.' SUP cim22Service MAY (cimBridgeLfMode) ) The following content rule specifies the auxiliary classes that may be attached to cim22SourceRoutingService. ( NAME 'cim22SourceRoutingServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22SourceRoutingService' AUX (cim22SwitchServiceSourceRoutingAuxClass $ cim22SwitchPortSourceRoutingAuxClass) ) 3.72 cim22SwitchServiceSourceRoutingAuxClass This auxiliary class that links SwitchService to a component SourceRoutingService. The cardinality of the SourceRoutingService is 0.1 for a VLAN-unaware switch. ( NAME 'cim22SwitchServiceSourceRoutingAuxClass' DESC 'An association linking SwitchService to a component SourceRoutingService. The cardinality of the SourceRoutingService is 0..1 for a VLAN-unaware switch. Attribute cimGroupComponentRef points to cim22SwitchService and attribute cimPartComponentRef points to cim22SourceRoutingService.' SUP cim22ServiceComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.73 cim22SwitchPortPairAuxClass This auxiliary class represents information regarding port pairings that is used by the SourceRoutingService of a switch. ( NAME 'cimBridgeNum' DESC 'A bridge number that uniquely identifies the path provided Expires 6/30/00 [Page 61] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 by this source routing bridge between the segments connected to high and low ports. The purpose of bridge number is to disambiguate between multiple paths connecting the same two LANs.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimBridgeState' DESC 'The state of dot1dPortPairBridgeNum. Writing "invalid(3)" to this property removes the association instance.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22SwitchPortPairAuxClass' DESC 'This association represents information regarding port pairings that is used by the SourceRoutingService of a switch. Both reference attributes point to cim22SwitchPort objects.' SUP cim22SAPSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimBridgeNum $ cimBridgeState) ) 3.74 cim22SwitchPortSourceRoutingAuxClass A switch capable of source routing maintains source-routing specific information about each port. This auxiliary class represents that information. ( NAME 'cimHopCount' DESC 'The maximum number of routing descriptors allowed in an All Paths or Spanning Tree Explorer frames.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimLocalSegment' DESC 'The segment number that uniquely identifies the segment to which this port is connected. Current source routing protocols limit this value to the range: 0 through 4095. (The value 0 is used by some management applications for special test cases.) A value of 65535 signifies that no segment number is assigned to this port.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimTargetSegment' DESC 'The segment number that corresponds to the target segment this port is considered to be connected to by the Expires 6/30/00 [Page 62] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 switch. Current source routing protocols limit this value to the range: 0 through 4095. (The value 0 is used by some management applications for special test cases.) A value of 65535 signifies that no target segment is assigned to this port.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cimSTESpanMode' DESC 'Determines how the port behaves when presented with a Spanning Tree Explorer frame. The value "disabled(2)" indicates that the port will not accept or send Spanning Tree Explorer packets; any STE packets received will be silently discarded. The value "forced(3)" indicates the port will always accept and propagate Spanning Tree Explorer frames. This allows a manually configured Spanning Tree for this class of packet to be configured. Note that unlike transparent bridging, this is not catastrophic to the network if there are loops. The value "auto-span(1)" can only be returned by a bridge that both implements the Spanning Tree Protocol and has use of the protocol enabled on this port. The behavior of the port for Spanning Tree Explorer frames is determined by the value of the State property of the SwitchPortSpanningTree association for the port. If the port is in the "forwarding" state, the frame will be accepted or propagated. Otherwise, it will be silently discarded.' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22SwitchPortSourceRoutingAuxClass' DESC 'A switch capable of source routing maintains source-routing specific information about each port. This association represents that information. Attribute cimAntecedentRef points to cim22SwitchPort and attribute cimDependentRef points to cim22SourceRoutingService.' SUP cim22ServiceSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimHopCount $ cimLocalSegment $ cimBridgeNum $ cimTargetSegment $ cimSTESpanMode) ) 3.75 cim22VLAN This class VLAN represents a VLAN within a switch. In a particular switch, there should be an instance of this object for every VLAN available in the switch. For example, in a switch with port-based VLANs, if there are 16 VLANs to which ports can be assigned (VLAN 1 Expires 6/30/00 [Page 63] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 through VLAN 16), there should be aninstance of cim22VLAN for each of VLAN 1 through VLAN 16. Use cimName for the textual name of the VLAN, if there is one. Otherwise, synthesize a textual name, e.g., VLAN 0003. (Consider leading zero fill, as shown, to ensure that if the textual VLAN names are extracted and presented by management applictions, the VLAN names will sort in the expected order. It is intended that cim22VLAN be subclassed only if necessary to add attributes. The type of the VLAN can be inferred from the VLANService(s) with which the cim22VLAN is associated via the cim22VLANForAuxClass object. ( NAME 'cimVLANNumber' SYNTAX integer SINGLE-VALUE ) ( NAME 'cim22VLAN' DESC 'An instance of cim22VLAN represents a VLAN within a switch.' SUP cim22ServiceAccessPoint MAY (cimVLANNumber) ) The following content rule specifies the auxiliary classes that may be attached to cim22VLAN. ( NAME 'cim22VLANContentRule' DESC 'The auxiliary classes that may be attached to cim22VLAN' AUX (cim22RelatedTransparentBridgingServiceAuxClass $ cim22InboundVLANAuxClass $ cim22OutboundVLANAuxClass) ) 3.76 cim22RelatedTransparentBridgingServiceAuxClass This auxiliary class maps between a VLAN and the forwarding database (some use the term filtering database) used to determine the port a packet should be transmitted on, given that it is assigned to the VLAN and that it has a particular destination MAC address. The TransparentBridgingServicerepresents a forwarding database. ( NAME 'cim22RelatedTransparentBridgingServiceAuxClass' DESC 'The association between a VLAN and the forwarding database(some use the term filtering database) used to determine which port a packet should be transmitted on, given that it is assigned to the VLAN and that it has a particular destination MAC address. The TransparentBridgingService represents a forwarding Expires 6/30/00 [Page 64] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 database. Attribute cimAntecedentRef points to cim22VLAN and attribute cimDependentRef points to cim22TransparentBridgingService.' SUP cim22ServiceSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.77 cim22RelatedSpanningTreeAuxClass This auxiliary class identifies the spanning tree in which a forwarding database (TransparentBridgingService) is nested. ( NAME 'cim22RelatedSpanningTreeAuxClass' DESC 'This association identifies the spanning tree in which a forwarding database (TransparentBridgingService) is nested. Attribute cimAntecedentRef points to cim22TransparentBridgingService and attribute cimDependentRef points to cim22SpanningTreeService.' SUP cim22ServiceServiceDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef) ) 3.78 cim22InboundVLANAuxClass If there is an association between a particular SwitchPort and a particular cim22VLAN, then there is the possibility that a packet received by the port will be assigned to the VLAN (or if the packet already has a VLAN tag, that the packet will not be dropped). If there is no such association, then there is no possibility that a packet received by the port will progress through the switch having been assigned to the VLAN in question. ( NAME 'cimTagged' DESC 'If true, packets already tagged with this VLAN number will be accepted when arriving at this port.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cimDefault' DESC 'Default should be true if untagged packets received by the Antecedent SwitchPort are assigned to the Dependent VLAN by default.' SYNTAX boolean SINGLE-VALUE ) ( NAME 'cim22InboundVLANAuxClass' DESC 'If there is an association between a particular SwitchPort and a particular cimVLAN, then there is the possibility Expires 6/30/00 [Page 65] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 that a packet received by the port will be assigned to the VLAN. Attribute cimAntecedentRef points to cim22VLAN and attribute cimDependentRef points to cim22SwitchPort.' SUP cim22SAPSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimTagged $ cimDefault) ) 3.79 cim22OutboundVLANAuxClass This class controls whether packets assigned to a particular VLAN may be transmitted over a given switch port. ( NAME 'cim22OutboundVLANAuxClass' DESC 'If there is no instance of OutboundVLAN between a given SwitchPort and cim22VLAN, then any packet that has been assigned to the VLAN and whose destination address is associated with the port will be dropped by the switch without being transmitted. Otherwise, the packet will be transmitted. Attribute cimAntecedentRef points to cim22VLAN and attribute cimDependentRef points to cim22SwitchPort.' SUP cim22SAPSAPDependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimTagged) ) 3.80 cim22VLANService This class represents the VLAN aspects of the function performed by a switch. Some VLAN-aware devices participate in protocols where VLAN information is propagated among switches, e.g., GVRP in 802.1Q switches and VTP in Cisco Catalyst switches. VLANService also represents the function performed by the switch as a participant in such a protocol. VLANService must be subclassed so that instances can be distinguished by their class. If there is a name assigned to a set of VLAN-aware switches, e.g., the VTP domain name in Cisco Catalyst switches, use the Name attribute inherited from cim22Service to store the name. A VLANService should be instantiated in a VLAN- aware switch even if there is no GVRP-like protocol. ( NAME 'cim22VLANService' DESC 'VLANService represents the VLAN aspects of the function performed by a switch. Some VLAN-aware devices participate in protocols where VLAN information is propagated among switches, e.g., GVRP in 802.1Q switches and VTP in Cisco Catalyst switches. VLANService also represents the function performed by the switch as a participant in such a protocol.VLANService must be subclassed so that instances can be distinguished by their class. If there is a name assigned to a set of VLAN-aware switches, e.g., the VTP domain name in Cisco Catalyst Expires 6/30/00 [Page 66] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 switches, use the Name attribute inherited from cim22Service to store the name. A VLANService should be instantiated in a VLAN-aware switch even if there is no GVRP-like protocol.' SUP cim22Service ) The following content rule specifies the auxiliary classes that may be attached to cim22VLANService. ( NAME 'cim22VLANServiceContentRule' DESC 'The auxiliary classes that may be attached to cim22VLANService' AUX (cim22SwitchServiceVLANAuxClass) ) 3.81 cim22802dot1QVLANService If a switch supports 802.1Q, an instance of this class should be instantiated in the switch. If the switch supports GVRP, this class represents the function that the switch performs with respect to GVRP. ( NAME 'cim22802dot1QVLANService' DESC 'If a switch supports 802.1Q, an instance of this class should be instantiated in the switch. If the switch supports GVRP, this class represents the function that the switch performs with respect to GVRP.' SUP cim22VLANService ) 3.82 cim22SwitchServiceVLANAuxClass This auxiliary class links SwitchService to a component VLANService. ( NAME 'cim22SwitchServiceVLANAuxClass' DESC 'An association linking SwitchService to a component VLANService. Attribute cimGroupComponentRef points to cim22SwitchService and attribute cimPartComponentRef points to cim22VLANService.' SUP cim22ServiceComponentAuxClass AUXILIARY MAY (cimGroupComponentRef $ cimPartComponentRef) ) 3.83 cim22VLANForAuxClass An auxiliary class linking SwitchService to a component VLANService. ( NAME 'cim22VLANForAuxClass' SUP cim22ServiceSAPDependencyAuxClass Expires 6/30/00 [Page 67] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 MAY (cimAntecedentRef $ cimDependentRef) ) 3.84 cim22AdapterActiveConnectionAuxClass This auxiliary class shows that a NetworkAdapter is using the referenced PhysicalConnector to output to the network. This relationship is important when the Adapter can choose to output from one of several Connectors. The Connectors may be associated with the NetworkAdapter in a Realizes relationship - but this is not required. This association provides additional information (i.e., 'in use for communication') that makes it different from the information provided by the Realizes association. ( NAME 'cim22AdapterActiveConnectionAuxClass' DESC 'The AdapterActiveConnection relationship indicates that a NetworkAdapter is using the referenced PhysicalConnector to output to the network. This relationship is important when the Adapter can choose to output from one of several Connectors. The Connectors may be associated with the NetworkAdapter in a Realizes relationship - but this is not required. This association provides additional information (i.e., "in use for communication") that makes it different than the information provided by the Realizes association. Attribute cimAntecedentRef points to cim22PhysicalConnector and attribute cimDependentRef points to cim22NetworkAdapter.' SUP cim22DependencyAuxClass AUXILIARY MAY (cimAntecedentRef $ cimDependentRef $ cimActive) ) 3.85 cim22EndpointIdentityAuxClass This auxiliary class shows that two ProtocolEndpoints represent different aspects of the same underlying address or protocol-specific ID. This association refines cim22LogicalIdentityAuxClass by restricting it to the Endpoint level and defining its use in well understood scenarios. One of these scenarios is to represent that an Endpoint has both 'LAN' and protocol-specific aspects. For example, an Endpoint could be both a LANEndpoint as well as a DHCPEndpoint. ( NAME 'cim22EndpointIdentityAuxClass' DESC 'EndpointIdentity indicates that two ProtocolEndpoints represent different aspects of the same underlying address or protocol-specific ID. This association refines the LogicalIdentity superclass by restricting it to the Endpoint level and defining its use in well understood scenarios. One of these scenarios is to represent that an Endpoint has both "LAN" and protocol-specific aspects. For Expires 6/30/00 [Page 68] INTERNET DRAFTLDAP Schema for the DMTF Network CIM v2.2 ModelDecember 1999 example, an Endpoint could be both a LANEndpoint as well as a DHCPEndpoint. Both attributes point to cim22ProtocolEndpoint objects.' SUP cim22LogicalIdentityAuxClass AUXILIARY MAY (cimSystemElementRef $ cimSameElementRef) ) 4. References Request For Comments (RFC) and Internet Draft documents are available from numerous mirror sites. [1] M. Wahl, T. Howes, S. Kille, "Lightweight Directory Access Protocol (v3)," RFC 2251, Decemeber 1997. [2] M. Wahl, A. Coulbeck, T. Howes, S. Kille, "Light- weight Directory Access Protocol (v3): Attribute Synatx Definitions," RFC 2252, December 1997. [3] Ryan Moats, Gerald Maziarski, John Strassner, "Extensible Match Rule to Dereference Pointers", Internet Draft (work in progress), June 1999. [4] DMTF, "CIM Network Model, v2.2". [5] Ryan Moats, Gerald Maziarski, John Strassner, "LDAP Schema for the DMTF Core CIM v2.2 Model", Internet Draft (work in progress), December 1999. [6] Ryan Moats, Gerald Maziarski, John Strassner, "LDAP Schema for the DMTF Device CIM v2.2 Model", Inter- net Draft (work in progress), December 1999. [7] Ryan Moats, Gerald Ma