CCAP Data Type Definitions

The following data types have been created to support the CCAP configuration object model. See Annex D, CCAP Data Type Definitions, for the primitive and derived data types used in this model.

28 _{Section added per CCAP-OSSI-N-12.1068-3 by JS on 7/16/12.} 29

Section added per CCAP-OSSI-N-13.1095-2 by CP on 3/11/13.

30

Table 6–2: Data Types31

Data Type Name Base Type Type Constraints Reference YANG Data Type

AdminState Enum other(1),

up(2), down(3), testing(4)

RFC 2863 admin-state-type

AttributeMask EnumBits bonded(0),

lowLatency(1), highAvailability(2)

OSSI attribute-mask-type

HePidValue UnsignedShort (0..8191 | 65535) SCTE 154-5

Host Choice of IpAddress or

InetDomainName

host

IpAddress InetAddress RFC 4001 inet:ip-address

InetAddressPrefixLength UnsignedByte 32 or 128 depending on IP version

RFC 4001 address-prefix-len-type InetIpPrefix Union of InetIpv4Prefix and

InetIpv6Prefix

RFC 6021 inet:ip-prefix InetIpv4Prefix Union of InetAddressIpv4 and

InetAddressPrefixLength

InetAddressPrefixLength: 32 RFC 4001 ipv4-prefix InetIpv6Prefix Union of InetAddressIpv6 and

InetAddressPrefixLength

InetAddressPrefixLength: 128

RFC 4001 ipv6-prefix InetHost Union of InetIpAddress and

InetDomainName

RFC 6021 inet:host

InetPortNum Short RFC 4001 inet:port-number

IPHostPrefix Union of IPv4HostPrefix and Ipv6HostPrefix

ip-host-prefix

Ipv4HostPrefix ipv4-host-prefix

Ipv6HostPrefix RFC 4291 ipv6-host-prefix

TenthdB Short RFC 4546

UpDownTrapEnabled Boolean IF-MIB up-down-trap-enabled

6.5.3.1 AdminState

This data type defines the Admin state. The value of other(1) is used when a vendor extension has been implemented for this attribute.

Reference: [RFC 2863]

6.5.3.2 AttributeMask

This data type consists of a sequence of 32-bit positions used to select the bonding group or the channel to which a service flow is assigned. DOCSIS defines three types of Attribute Masks for which this type applies: the Provisioned Attribute Mask that is configured to a Bonding Group or a single-channel, whereas the Required Attribute and the Forbidden Attribute Mask are part of the Service Flow QOS Parameter Set to be matched with the Provisioned Attribute Mask of CMTS-configured Bonding Groups or single-channels. DOCSIS reserves the assignment of the meaning of the first 8 bit positions (left to right) as follows:

Bit 0: bonded Bit 1: lowLatency Bit 2: highAvailability

Bit positions 3-15 are reserved.

31

Revised per CCAP-OSSI-N-12.1031-3 by JB on 3/12/12; per CCAP-OSSI-N-12.1068-3 by JS on 7/16/12, and per CCAP- OSSI-N-13.1095-2 by CP on 3/11/13.

Bit positions 16-31 are freely assigned by operators to represent their own constraints on the channel(s) selection for a particular service flow.

Reference: [OSSIv3.0], AttributeMask section.

6.5.3.3 HePidValue

This data type represents a packet identifier (PID) value which ranges from 0 to (2^13 - 1). The value of 65535 indicates that either the PID is invalid or does not exist.

Reference: [SCTE 154-5]

6.5.3.4 Host32

The host type represents either a strongly-typed IP address or a DNS domain name. Use of this type avoids the weak validation inherent in the union-based inet:host type, as with this type an ip-address cannot be inappropriately validated as a domain-name accidentally. For a particular use of this data type, the CCAP MAY support only one of these choices: either an IP address or an FQDN.

For attributes with the HOST data type, the CCAP MUST support configuring an IP address. For attributes with the Host data type, the CCAP SHOULD support configuring an FQDN.

6.5.3.5 IpAddress

The IpAddress data type refers to the InetAddress textual convention defined in [RFC 4001]. It is an octet string of length 4 for an IPv4 address and of length 16 for an IPv6 address. An object of type InetAddress is always

interpreted in the context of an object of InetAddressType that selects whether the InetAddress is IPv4 or IPv6. Reference: [RFC 4001]

6.5.3.6 InetAddressPrefixLength

This data type corresponds to the InetAddressPrefixLength textual description defined in [RFC 4001]. It is the number of contiguous "1" bits from the most significant bit of an InetAddress.

Reference: [RFC 4001]

6.5.3.7 InetIpPrefix33

This data type is a union of InetIpv4Prefix and InetIpv6prefix and represents an IP prefix. It is IP version neutral. The format of the textual representations implies the IP version.

6.5.3.8 InetIpv4Prefix

This data type is a union of the InetAddressIpv4 and InetAddressPrefixLength textural conventions defined in [RFC 4001]. It corresponds to the ipv4-prefix data type defined in [RFC 6021].

Reference: [RFC 4001]

6.5.3.9 InetIpv6Prefix

This data type is a union of the InetAddressIpv6 and InetAddressPrefixLength textural conventions defined in [RFC 4001]. It corresponds to the ipv6-prefix data type defined in [RFC 6021].

Reference: [RFC 4001], [RFC 6021]

32

Section added per CCAP-OSSI-N-13.1095-2 by CP on 3/11/13, revised per CCAP-OSSI-N-13.1116- on 7/22/13 by PO.

33

6.5.3.10 InetPortNum

This integer represents the port number configured. Reference: [RFC 4001]

6.5.3.11 InetHost34

This data type represents a FQDN, or IPv4 address or IPv6 address and a port number. Reference: [RFC 6021]

6.5.3.12 IPHostPrefix35

This data type represents an IP host address plus prefix and is IP version neutral. The format of the textual representations implies the IP version. This type is similar to inet:ip-prefix.

This data type is the union of the Ipv4HostPrefix data type and the Ipv6HostPrefix data type.

6.5.3.13 Ipv4HostPrefix36

This data type represents an IPv4 host address plus the prefix length, separated by a slash. The prefix length is given by the number following the slash character and must be less than or equal to 32. A prefix length value of n

corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

This type is derived from the inet:ipv4-prefix type, which has all bits of the IPv4 address set to zero that are not part of the IPv4 prefix. Use of that type requires separate configuration of the interface host address.

The pattern for this looks like: (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0- 9]|2[0-4][0-9]|25[0-5])/(([0-9])|([1-2][0-9])|(3[0-2]))

6.5.3.14 Ipv6HostPrefix37

This data type is derived from the inet:ipv6-prefix type, which has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Use of that type requires separate configuration of the interface host address. The IPv6 address is represented in the compressed format described in [RFC 4291], Section 2.2, item 2 with the following additional rules: the “::” substitution is applied to the longest sequence of all-zero 16-bit chunks in an IPv6 address. If there is a tie, the first sequence of all-zero 16-bit chunks is replaced by “::”. Single, all-zero 16-bit chunks are not compressed. The canonical format using lowercase characters and leading zeros are not allowed.

Reference: [RFC 4291]

The pattern for this looks like this:

((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + '(((25[0-5]|2[0- 4][0-9]|[01]?[0-9]?[0-9])\.){3}' + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + '(/(([0-9])|([0-9]{2})|(1[0-1][0- 9])|(12[0-8])))';

pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|' + '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + '(/.+)';

6.5.3.15 TenthdB

This data type represents power levels that are normally expressed in dB. Units are in tenths of a dB; for example, 5.1 dB will be represented as 51.

34

Added per CCAP-OSSI-N-12.1068-3 by JS on 7/16/12.

35 _{Added per CCAP-OSSI-N-13.1095-2 by CP on 3/12/13.} 36

Added per CCAP-OSSI-N-13.1095-2 by CP on 3/12/13.

37

Reference: [RFC 4546]

6.5.3.16 UpDownTrapEnabled38

Indicates whether linkUp/linkDown traps should be generated for this interface. This is a boolean type, where true means that the trap is enabled.

Reference: [RFC 2863], ifLinkUpDownTrapEnable