6.5 UML Configuration Object Model
6.5.9 Interface Configuration Objects
Interfaces in the CCAP are different than ports, in that they are intended to be Layer 3 entities. The following object model shows the relationships for interfaces in the CCAP.
Figure 6–18: Interface Configuration Objects188
187
Revised per CCAP-OSSI-N-12.1031-3 on 3/16/12 by JB. Revised per CCAP-OSSI-N-12.1068-3 by JS on 7/18/12.
188
6.5.9.1 Ccap
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.4.1, Ccap Object.
6.5.9.2 IfCfg
The IfCfg object is the primary container of interface configuration objects.
Table 6–207: IfCfg Object Associations
Associated Object Name Type Near-end
Multiplicity
Far-end Multiplicity
Label
CableBundle Directed composition to CableBundle 0..*
Loopback Directed composition to Loopback 0..*
MgmdRouterInterface Directed composition to
MgmdRouterInterface
0..1
6.5.9.3 Loopback
A loopback interface is a logical interface that is not tied to a specific hardware port. The CCAP MUST support a loopback interface to provide a virtual interface to assist in overall system configuration.
Table 6–208: Loopback Object Associations
Associated Object Name Type Near-end
Multiplicity
Far-end Multiplicity
Label
VirtualInterface Specialization of VirtualInterface
6.5.9.4 VirtualInterface
The VirtualInterface abstract object contains attributes shared by CCAP virtual interfaces (Loopback and CableBundle).
Table 6–209: VirtualInterfaceObject Attributes
Attribute Name Type Required
Attribute
Type Constraints Units Default Value
Index UnsignedByte Yes (Key)
AdminState AdminState No down
Table 6–210: VirtualInterface Object Associations
Associated Object Name Type Near-end Multiplicity Far-end Multiplicity Label
IpInterface Directed composition to IpInterface 1 0..1
6.5.9.5 IpInterface
IpInterface is an object used to configure an IP interface on the CCAP. Attributes from this object are used by the CableBundle, Loopback, and EnetPort objects. For a CCAP operating in non-routing mode, an IpInterface instance need not be configured for CableBundle objects.
Table 6–211: IpInterface Object Attributes
Attribute Name Type Required
Attribute
Type Constraints Units Default Value
Name String Yes (Key)
IpInterfacehas several associations.
Table 6–212: IpInterface Object Associations
Associated Object Name Type Near-end
Multiplicity
Far-end Multiplicity
Label
PrimaryIpv4 Directed composition to PrimaryIpv4 0..1
Ipv6 Directed composition to Ipv6 0..*
SecondaryIpv4 Directed composition to SecondaryIpv4 0..*
6.5.9.5.1 IpInterface Object Attributes
6.5.9.5.1.1 Name
The name for this instance of an interface. This name is used to reference a specific IpInterface instance and associate it with the referring object.
6.5.9.6 PrimaryIpv4
The PrimaryIpv4 object allows a primary IPv4 interface address to be configured.
Table 6–213: PrimaryIpv4 Object Attributes189
Attribute Name Type Required Attribute
Type Constraints Units Default Value
IpAddress Ipv4HostPrefix Yes
6.5.9.6.1 PrimaryIpv4 Attributes 6.5.9.6.1.1 IpAddress
This attribute configures the IPv4 address and prefix for this instance.
6.5.9.7 Ipv6
The PrimaryIpv6 object allows a primary IPv6 interface address to be configured. For IPv6 addresses, the concept of primary and secondary does not apply; for this reason, a list of IPv6 addresses may be configured.
Table 6–214: Ipv6 Object Attributes190
Attribute Name Type Required Attribute
Type Constraints Units Default Value
Ipv6Address Ipv6HostPrefix Yes
189
Revised table per CCAP-OSSI-N-13.1095-2 by CP on 3/15/13.
190
6.5.9.7.1 Ipv6 Attributes 6.5.9.7.1.1 Ipv6Address
This attribute configures the IPv6 address and prefix for this instance.
6.5.9.8 SecondaryIpv4
The SecondaryIpv4 object allows secondary IPv4 addresses to be configured.
Table 6–215: SecondaryIpv4 Object Attributes191
Attribute Name Type Required Attribute
Type Constraints Units Default Value
IpAddress Ipv4HostPrefix Yes
6.5.9.8.1 SecondaryIpv4 Attributes 6.5.9.8.1.1 IpAddress
This attribute configures the IPv4 address and prefix for this instance.
6.5.9.9 CableBundle
A CableBundle is a compact way of assigning Layer 3 network addresses to a set of Layer 2 interfaces. This allows the bundled Layer 2 interfaces to share a common pool of IPv4 Subnets or IPv6 prefixes so that these IP address resources can be efficiently used by the CCAP operating in routing mode.
Table 6–216: CableBundle Object Attributes192
Attribute Name Type Required
Attribute
Type Constraints Units Default Value
DhcpGiAddrPrimary Ipv4Address Yes
A CableBundle can only be associated with MAC domains of a given type; the CCAP MUST reject the configuration of a CableBundle instance in which both an MdCfg and an EponMdCfg have been configured.
Table 6–217: CableBundle Object Associations193
Associated Object Name Type Near-end Multiplicity Far-end Multiplicity Label
MdCfg Directed aggregation to MdCfg 0..1 0..* DocsMdName
EponMdCfg Directed aggregation to EponMdCfg 0..1 0..* EponMdName
CableHelperCfg Directed composition to CableHelperCfg 1 0..*
SecondaryGiAddr Directed composition to SecondaryGiAddr 1 0..*
IpAcl Directed association to IpAcl 0..1 Ingress
IpAcl Directed association to IpAcl 0..1 Egress
191 Revised table per CCAP-OSSI-N-13.1095-2 by JS on 3/29/13. 192
Revised table per CCAP-OSSI-N-13.1095-2 by CP on 3/15/13.
193
6.5.9.9.1 CableBundle Object Attributes 6.5.9.9.1.1 DhcpGiAddrPrimary
This attribute configures how the DHCP relay agent populates the GiAddr for relayed DHCP traffic on the CCAP in routing mode.
6.5.9.10 CableHelperCfg
The CableHelperCfg configuration object allows the operator to configure different Cable Helper addresses for DHCP Clients. The CCAP operating in routing mode ties these Cable Helper addresses to the CableBundle interfaces and the MAC Domains they service.
Table 6–218: CableHelperCfg Object Attributes194
Attribute Name Type Required
Attribute
Type Constraints Units Default Value
Index UnsignedInt Yes (Key)
Address Host Yes
Application Enum No other(1)
host(2) mta(3) stb(4) cm(5) all(6) all
6.5.9.10.1 CableHelperCfg Object Attributes 6.5.9.10.1.1 Index
The index for the CableHelperCfg instance.
6.5.9.10.1.2 Address195
This attribute configures the IP address or FQDN of the DHCP server configured as a cable helper.
6.5.9.10.1.3 Application
This attribute configures the device class for which this cable helper configuration applies. The value of other(1) is used when a vendor-extension has been implemented for this attribute.
6.5.9.11 SecondaryGiAddr196
This object allows a secondary GiAddr to be configured for a CableBundle instance.
Table 6–219: SecondaryGiAddr Object Attributes
Attribute Name Type Required Attribute
Type Constraints Units Default Value
DhcpGiAddrSecondary Ipv4Address Yes (Key)
194 Revised table per CCAP-OSSI-N-13.1095-2 by CP on 3/15/13. 195
Revised section per CCAP-OSSI-N-13.1095-2 by CP on 3/15/13.
196
Attribute Name Type Required Attribute
Type Constraints Units Default Value
Application Enum No other(1)
host(2) mta(3) stb(4) cm(5)
all(6) all
6.5.9.11.1 SecondaryGiAddr Object Attributes 6.5.9.11.1.1 DhcpGiAddrSecondary
This attribute configures how the DHCP relay agent populates the secondary GiAddr for relayed DHCP traffic on the CCAP in routing mode.
6.5.9.11.1.2 Application
This attribute configures the device class for which this GiAddr instance applies. The value of other(1) is used when a vendor-extension has been implemented for this attribute.
6.5.9.12 MacDomainCfg
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.7.6.6, MacDomainCfg.
6.5.9.13 EponMdCfg
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.11.6, EponMdCfg.
6.5.9.14 MdCfg
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.7.6.4, MdCfg.
6.5.9.15 EnetPort
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.21, EnetPort.
6.5.9.16 OneGigEthernet
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.22, OneGigEthernet.
6.5.9.17 TenGigEthernet
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.23, TenGigEthernet.
6.5.9.18 FortyGigEthernet
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.24, FortyGigEthernet.
6.5.9.19 OneHundredGigEthernet
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.25, OneHundredGigEthernet.
6.5.9.20 Port
This configuration object is included in Figure 6–18 for reference. It is defined in Section 6.5.5.10, Port.
6.5.9.21 MgmdRouterInterface
This configuration object allows for configuration of the CCAP IP Multicast Router. These configuration objects are defined in the Multicast Group Membership Discovery MIB, [RFC 5519]. The table shown here is derived from this MIB.
Table 6–220: MgmdRouterInterface Object Attributes
Attribute Name Type Required Attribute
Type Constraints Units Default Value
QueryInterval UnsignedInt No seconds 125
Version Enum No other(1),
igmpv1(2), igmpv2OrMldv1(3),
igmpv3OrMldv2(4) igmpv2OrMldv1
QueryMaxResponseTime UnsignedInt No 0..31744 tenths of seconds 100
Robustness UnsignedInt No 1..225 2
LastMemberQueryInterval UnsignedInt No 0..31744 tenths of seconds 10
6.5.9.21.1 MgmdRouterInterface Object Attributes 6.5.9.21.1.1 QueryInterval
The frequency in seconds at which IGMP or MLD Host-Query packets are transmitted on this interface.
6.5.9.21.1.2 Version
The version of MGMD that is running on this interface. Value 2 applies to IGMPv1 routers only. Value 3 applies to IGMPv2 and MLDv1 routers, and value 4 applies to IGMPv3 and MLDv2 routers.
This object can be used to configure a router capable of running either version. For IGMP and MLD to function correctly, all routers on a LAN must be configured to run the same version on that LAN.
6.5.9.21.1.3 QueryMaxResponseTime
The maximum query response interval in seconds advertised in MGMDv2 or IGMPv3 queries on this interface.
6.5.9.21.1.4 Robustness
The robustness variable utilized by an MGMDv3 host in sending state-change reports for multicast routers. To ensure the state-change report is not missed, the host retransmits the state-change report
[mgmdHostInterfaceVersion3Robustness – 1] times. The variable must be a non-zero value.
6.5.9.21.1.5 LastMemberQueryInterval
The Last Member Query Interval is the Max Query Response Interval in tenths of a second inserted into group- specific queries sent in response to leave group messages, and is also the amount of time between group-specific query messages. This value may be tuned to modify the leave latency of the network. A reduced value results in reduced time to detect the loss of the last member of a group. The value of this object is irrelevant if