Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2 Root Object Model with oneM2M extensions
tr-181-2-99-0.xml (changes)

Notice

Summary

Device:2.99 data model. Includes oneM2M extensions

Table of Contents

Data Types

The parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. The complete set of data types, along with the notation used to represent these types, is listed in [Appendix I.4/TR-106a7]. The following named data types are used by this specification.

Data Type Base Type Description

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.

Device:2.99 Data Model (changes)

For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 2.99, then it will indicate support for version 2.99. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
X_oneM2M_CSENumberOfEntries unsignedInt - The number of entries in the X_oneM2M_CSE table. - 2.99
Device.X_oneM2M_CSE.{i}. object W This object represents an instance of a Common Service Entity (CSE) for a M2M device or gateway.

The X_oneM2M_CSE MAY be maintained by the ACS or by the CPE.

When the X_oneM2M_CSE provides the administration of an CSE that is represented as a SoftwareModules.ExecutionUnit the X_oneM2M_CSE is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter.

Clause 6.2.9 of the oneM2M Functional Architecture [ONEM2MFA] describes the high level description for CSE registration.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
M2MAreaNetworkNumberOfEntries unsignedInt - The number of entries in the M2MAreaNetwork table. - 2.99
M2MAreaNetworkDeviceNumberOfEntries unsignedInt - The number of entries in the M2MAreaNetworkDevice table. - 2.99
Device.X_oneM2M_CSE.{i}.M2MAreaNetwork.{i}. object - The M2M Area Network information provides administration capabilities for remote management of Application Dedicated Nodes (ADN) and devices in the M2M Network that are attached to this X_oneM2M_CSE instance.

This object provides the administration of the properties needed by the CSE to remotely manage ADN and devices in the M2M Network within a specific type of M2M Area network as defined by Type.

Multiple instances of M2MAreaNetwork with the same Type is permitted.

At most one entry in this table can exist with a given value for ID.

- 2.99
ID string - URI [RFC3986] that represents the identifier of the instance. - 2.99
Type string - ADN and devices in the M2M Network that connect to an CSE are said to be "attached devices" and are organized by M2M Area Networks within the X_oneM2M_CSE instance. The Type is an implementation-chosen string that indicates the type of M2M Area Network. - 2.99
Devices string - Comma-separated list of strings. Each list item MUST be the path name of a row in the M2MAreaNetworkDevice table, or an empty string.

The list represents the ADN and devices in the M2M Network that are attached to this X_oneM2M_CSE instance that are within this M2MAreaNetwork instance. The list does not contain an instance for this CPE.

- 2.99
Device.X_oneM2M_CSE.{i}.M2MAreaNetworkDevice.{i}. object - This object provides the administration capability to the CSE for maintenance of ADN and devices in the M2M Network that are attached to this X_oneM2M_CSE instance.

While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the Hosts.Host table.

When the ADN or a device in the M2M Network is managed by the CWMP endpoint of the CPE, the M2MAreaNetworkDevice is expected to be referenced by an instance of one of the following tables:

This object instance provides the administration properties required by a CSE to remotely manage an instance of a ADN or a device in the M2M Network within a M2M area network.

A ADN or a device in the M2M Network is associated with an instance of a M2MAreaNetwork.

This table contains parameters and information of the ADN or a device in the M2M Network related to each M2MAreaNetwork instance.

Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device.

- 2.99
M2MAreaNetwork string - The value MUST be the path name of a row in the M2MAreaNetwork table. - 2.99
Host string - Comma-separated list of strings. Each list item MUST be the path name of the Hosts.Host table entry that represents an active or inactive ADN or a device in the M2M Network. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
Type string - The type of that device that indicates the functions or services provided by the ADN or a device in the M2M Network. Examples include temperature sensor, actuator, Zigbee coordinator or Zigbee router. - 2.99
Neighbors string - Comma-separated list of strings. Each list item MUST be the path name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that represent the reachable neighbors of this ADN or a device in the M2M Network. - 2.99
SleepInterval unsignedInt W The interval, in seconds, between sleep periods for the device.

A value of 0 represents a device that does not sleep.

Note: When this value is modified, the CPE could modify the SleepInterval for this ADN or a device in the M2M Network in other M2M Area Networks.

- 2.99
SleepDuration unsignedInt W The duration, in seconds, of a sleep period.

The value 0 represents an unknown value.

Note: When this value is modified, the CPE could modify the SleepDuration for this ADN or a device in the M2M Network in other M2M Area Networks.

- 2.99
Status string - The sleep status of the device.

Enumeration of:

- 2.99
Active boolean - Whether or not this M2M Device is currently attached to this X_oneM2M_CSE instance.

The ability to list inactive a ADN or device in the M2M Network is OPTIONAL. If the CPE includes inactive ADNs and devices in the M2M Network in this table, Active is set to false for each inactive ADN or device in the M2M Network. The length of time an inactive ADN or device in the M2M Network remains listed in this table is a local matter to the CPE.

- 2.99
Device.X_oneM2M_CSE.{i}.CMDH. object - This object represents the Policies and Rules necessary to administer the Communication Management and Delivery Handling (CMDH) functions within a CSE. - 2.99
PolicyNumberOfEntries unsignedInt - The number of entries in the Policy table. - 2.99
DefaultNumberOfEntries unsignedInt - The number of entries in the Default table. - 2.99
DefaultECRuleNumberOfEntries unsignedInt - The number of entries in the DefaultECRule table. - 2.99
DefaultECParamRuleNumberOfEntries unsignedInt - The number of entries in the DefaultECParamRule table. - 2.99
LimitNumberOfEntries unsignedInt - The number of entries in the Limit table. - 2.99
NetworkAccessECRuleNumberOfEntries unsignedInt - The number of entries in the NetworkAccessECRule table. - 2.99
NetworkAccessRuleNumberOfEntries unsignedInt - The number of entries in the NetworkAccessRule table. - 2.99
BufferNumberOfEntries unsignedInt - The number of entries in the Buffer table. - 2.99
Device.X_oneM2M_CSE.{i}.CMDH.Policy.{i}. object W This object describes the parameters necessary to administer the Communication Management and Delivery Handling (CMDH) handling policies applied to requests to access remotely hosted resources. Annex D.12 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH processing. Only one instance of this object shall be enabled for the X_oneM2M_CSE.{i} instance.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
Name string­(64) W The name that of this Policy instance. - 2.99
DefaultRule string W The value MUST be the path name of an Default.{i} object instance. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.99
LimitRules string W Comma-separated list of strings. Each list item MUST be the path name of an Limit.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
NetworkAccessECRules string W Comma-separated list of strings. Each list item MUST be the path name of an NetworkAccessECRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
BufferRules string W Comma-separated list of strings. Each list item MUST be the path name of an Buffer.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
Device.X_oneM2M_CSE.{i}.CMDH.Default.{i}. object W This object describes the parameters necessary to administer the CMDH default values that are used for requests issued by Originators (registered AEs or functions inside the CSE itself). Annex D.12.1 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Default processing.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
DefaultECRules string W Comma-separated list of strings. Each list item MUST be the path name of an DefaultECRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
DefaultECParamRules string W Comma-separated list of strings. Each list item MUST be the path name of an DefaultECParamRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
Device.X_oneM2M_CSE.{i}.CMDH.DefaultECRule.{i}. object W This object is used to define a value for the event category (ec) for an incoming request when it is not defined. Annex D.12.2 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for determining the ec based on the rule criteria.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
Order unsignedInt­[1:] W Position of the DefaultECRule entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each request, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of Order on creation of a DefaultECRule table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

- 2.99
RequestOrigin string W Rule criterion.

Comma-separated list of strings, of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’.

- 2.99
RequestContext string W Rule criterion.

This parameter defines the dynamic context condition under which the rule is applicable.

This may refer to conditions such as current battery status, or current network signal strength

- 2.99
RequestContextNotificationEnable boolean W When true, the CSE will establish a subscription to the dynamic context information defined in the RequestContext parameter as well as a subscription to the value of the EventCategory for all AEs corresponding to the AE-ID or an App-ID appearing in the RequestOrigin parameter. false 2.99
RequestCharacteristics string W Rule criterion.

This parameter defines the conditions pertaining to the request itself, such as the requested response type (rt attribute) or other attributes of the request.

- 2.99
EventCategory string W Rule result.

The value to use for the ec parameter of the request if the conditions expressed in the rule criterion match.

- 2.99
Device.X_oneM2M_CSE.{i}.CMDH.DefaultECParamRule.{i}. object W This object is used to define a specific set of default values for the CMDH related parameters request expiration timestamp (rget), result expiration timestamp (rset), operational execution time (oet), response persistence (rp) and delivery aggregation (da) that are applicable for a given event category (ec) if these parameters are not specified in the request. Annex D.12.3 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for determining the ec based on the rule criteria.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

At most one enabled entry in this table can exist with a given value for EventCategory.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
EventCategory string W The Event Category for which the defaults are used when a request doesn't have a value for request field. - 2.99
RequestExpTime unsignedInt­[0:100] W Default value, in milliseconds, for the request expiration time parameter (‘rqet’) in a request when the ‘rqet’ attribute of the request is not set. - 2.99
ResultExpTime unsignedInt­[0:100] W Default value, in milliseconds, for the result expiration time parameter (‘rset’) in a request when the ‘rset’ attribute of the request is not set. - 2.99
OperationExecTime unsignedInt­[0:100] W Default value, in milliseconds, for the operational execution time parameter (‘oet’) in a request when the ‘oet’ attribute of the request is not set. - 2.99
ResponsePersistence unsignedInt­[0:100] W Default value, in milliseconds, for the response persistence parameter (‘rp’) in a request when the ‘rp’ attribute of the request is not set. - 2.99
DeleteAggregation string W Default value for the delivery aggregation parameter (‘da’) in a request when the ‘da’ attribute of the request is not set. - 2.99
Device.X_oneM2M_CSE.{i}.CMDH.Limit.{i}. object W This object describes the parameters necessary to administer the CMDH limits for requests issued by Originators (registered AEs or functions inside the CSE itself). Annex D.12.4 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Limits processing.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
Order unsignedInt­[1:] W Position of the Limit entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each request, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of Order on creation of a Limit table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

- 2.99
RequestOrigin string W Rule criterion.

Comma-separated list of strings, of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’.

- 2.99
RequestContext string W Rule criterion.

This parameter defines the dynamic context condition under which the rule is applicable.

This may refer to conditions such as current battery status, or current network signal strength

- 2.99
RequestContextNotificationEnable boolean W When true, the CSE will establish a subscription to the dynamic context information defined in the RequestContext parameter as well as a subscription to this resource for all AEs corresponding to the AE-ID or an App-ID appearing in the RequestOrigin parameter. false 2.99
RequestCharacteristics string W Rule criterion.

This parameter defines the conditions pertaining to the request itself, such as the requested response type (rt attribute) or other attributes of the request.

- 2.99
EventCategories string W Rule Limit.

Comma-separated list of strings.

Allowed values for the event category parameter (‘ec’) in a request

- 2.99
RequestExpTime string W Rule Limit

Comma-separated list of strings.

Range of allowed values for the request expiration time parameter (‘rqet’) in a request.

For each list entry, ranges in the form "n-m" are permitted.

- 2.99
ResultExpTime string W Rule Limit

Comma-separated list of strings.

Range of allowed values for the result expiration time parameter (‘rset’) in a request.

For each list entry, ranges in the form "n-m" are permitted.

- 2.99
OperationExecTime string W Rule Limit

 Comma-separated list of strings.
Range of allowed values for the operational execution time parameter(‘oet’) in a request.

For each list entry, ranges in the form "n-m" are permitted.

- 2.99
ResponsePersistence string W Rule Limit

Comma-separated list of strings.

Range of allowed values for the response persistence parameter (‘rp’) in a request.

For each list entry, ranges in the form "n-m" are permitted.

- 2.99
DeleteAggregation string W Rule Limit

Comma-separated list of strings.

List of allowed values for the delivery aggregation parameter (‘da’) in a request.

- 2.99
Device.X_oneM2M_CSE.{i}.CMDH.NetworkAccessECRule.{i}. object W This object describes the parameters necessary to define the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE. Annex D.12.5 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Network Access Rule processing for specified event categories.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
EventCategories string W Rule Criterion.

Comma-separated list of strings.

This parameter defines the applicable event categories for which requests the rules contained in NetworkAccessRules are applied.

- 2.99
NetworkAccessRules string W Comma-separated list of strings. Each list item MUST be the path name of an NetworkAccessRule.{i} object instance. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.99
Device.X_oneM2M_CSE.{i}.CMDH.NetworkAccessRule.{i}. object W This object describes the parameters necessary is used define limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH related requests. Annex D.12.6 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Network Access Rule processing.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
TargetNetworks string W Rule Criterion.

Comma-separated list of strings.

This parameter defines for which underlying networks the usage limits contained in this NetworkAccessRule instance is applied.

- 2.99
MinimumReqVolume unsignedInt­[0:100] W Rule Criterion

Minimum amount of data, in bytes, that needs to be aggregated before any of the Underlying Networks matching with a value in the TargetNetworks parameter can be used for forwarding information to other CSEs.

- 2.99
AllowedSchedule string W Rule Criterion

Allowed schedule for any of the Underlying Networks matching with a value in the TargetNetworks parameter can be used for forwarding information to other CSEs.

XXX 0: Need to define the schedule

- 2.99
BackoffTime unsignedInt­[0:100] W Rule Result

Time, in milliseconds, that defines how long a CSE needs to wait before attempting to use a specific Underlying Network again after a first failed attempt.

- 2.99
BackoffTimeIncrement unsignedInt­[0:100] W Rule Result

This parameter defines by how much the back-off time shall be increased after each additional consecutive failed attempt to use the same Underlying Network without success.

- 2.99
MaximumBackoffTime unsignedInt­[0:100] W Rule Result

Time, in milliseconds, that defines the maximum wait time before attempting to use an Underlying Network again after previous failures.

- 2.99
Device.X_oneM2M_CSE.{i}.CMDH.Buffer.{i}. object W This object describes the parameters necessary to administer the CMDH limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE). Annex D.12.7 of the M2M Functional Architecture [ONEM2MFA] describes the behavior for CMDH Buffer processing.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.99
Enable boolean W Administratively enables or disables this instance. false 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
EventCategories string W Rule Limit.

Comma-separated list of strings.

Allowed values for the event category parameter (‘ec’) in a request

- 2.99
MaximumBufferSize unsignedInt­[0:100] W Rule Limit

Maximum amount of memory, in Kilobytes, that can be used for buffering requests matching with a value in the EventCategories parameter.

- 2.99
StoragePriority unsignedInt­[1:10] W Rule Result

Storage priority for data that is stored for buffering requests matching with this Buffer instance

- 2.99
Device.DeviceInfo. object - This object contains general device information. - 2.0
Device.DeviceInfo.X_oneM2M_BatteryStatus. object - This object status of the batteries on the device. - 2.99
BatteryNumberOfEntries unsignedInt - The number of entries in the Battery table. - 2.99
Device.DeviceInfo.X_oneM2M_BatteryStatus.Battery.{i}. object - This object represents information that the device has obtained via sampling the battery instance.

At most one entry in this table can exist with a given value for Alias.

- 2.99
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.99
Level string - The current battery level. - 2.99
Status string - Current status of the battery. - 2.99
Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 2.0
Device.ManagementServer.EmbeddedDevice.{i}. object - Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices.

At most one entry in this table can exist with the same values for ControllerID and ProxiedDeviceID.

- 2.3
ProxyProtocol string - The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.

- 2.3
DiscoveryProtocol string - Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to.

- 2.6
Device.ManagementServer.VirtualDevice.{i}. object - Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex I.1.1/TR-069a4] for proxying devices.

At most one entry in this table can exist with all the same values for ManufacturerOUI, ProductClass and SerialNumber.

- 2.3
ProxyProtocol string - The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.

- 2.3
DiscoveryProtocol string - Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a3] MUST be adhered to.

- 2.6

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object via AddObject and DeleteObject is REQUIRED.
A Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED.

X_oneM2M_CSEBaseline:1 Profile

This table defines the X_oneM2M_CSEBaseline:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.99.

Name Requirement
Device.­X_oneM2M_CSE.­{i}. C
Enable W
M2MAreaNetworkNumberOfEntries R
M2MAreaNetworkDeviceNumberOfEntries R
Device.­X_oneM2M_CSE.­{i}.­M2MAreaNetwork.­{i}. P
Type R
Devices R
Device.­X_oneM2M_CSE.­{i}.­M2MAreaNetworkDevice.­{i}. P
M2MAreaNetwork R
Host R
Type R
Neighbors R
SleepInterval W
SleepDuration W
Status R
Active R


Generated by Broadband Forum report.pl#254 (2014/01/03 version) on 2014/05/01 at 11:50:29.
report.exe --include='' --include=SECTIO~1 --include=SECTIO~2 --include=includes --report=html --option ReportGUI=2.5 --LastOnly --loglevel=w0 tr-181-2-99-0.xml ...