oneM2M TR-181i2 data model oneM2M TS-0001 v3.4.0 oneM2M Functional Architecture oneM2M February 2017 http://www.oneM2M.org oneM2M TS-0004 v3.0.0 Service Layer CoreProtocol Specification oneM2M March 2017 http://www.oneM2M.org oneM2M TS-0003 v3.1.0 Security Solutions oneM2M February 2017 http://www.oneM2M.org oneM2M TS-0022 v0.11.0 Field Device Configuration oneM2M March 2017 http://www.oneM2M.org RFC 6920 Naming Things with Hashes IETF RFC 2013 http://tools.ietf.org/html/rfc6920 see {{bibref|ONEM2MFA}} see {{bibref|ONEM2MFA}} see {{bibref|ONEM2MFA}} see {{bibref|ONEM2MFA}} This object represents the status of the batteries on the device. {{numentries}} This object represents information that the device has obtained via sampling the battery instance. {{datatype|expand}} The current battery level as a {{units}} of the battery capacity. Current status of the battery. The battery is operating normally and no connected to a power source. The battery is currently charging. The battery is fully charges and connected to a power source. The battery is a problem that would cause it to be damaged. The battery level is considered low. The battery is not installed. The battery status is unknown. This object represents the oneM2M diagnostics for a device. {{numentries}} This object represents a diagnostic that collects log data for the log type specified by the value of the {{param|Type}} parameter. The logging of the {{object}} instance is manipulated using the {{param||Enable}} parameter . The data that has been logged is available via the value of the {{param|Data}} parameter. Administratively enables or disables the log collection activity on this instance. The current logging state of the instance. {{enum}} When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Stopped}} or {{enum|Error}} if there is a error condition that does not allow the logging activity. When {{param|Enable}} is changed to {{true}} then {{param}} * SHOULD change to {{enum|Started}} if and only if the instance is providing the logging activity. * SHOULD remain in the {{enum|Error}} state if there is an error condition that does not allow the logging activity * SHOULD remain in the {{enum|NotPresent}} state if the type of log is not present; it SHOULD change to {{enum|Unknown}} if the state of the value of the {{param|LogFile}} parameter for the value of the {{param|Type}} parameter can not be determined for some reason. {{datatype|expand}} The type of event log on which to collect data. The association of the value of this {{param}} parameter with the associated {{object|##.VendorLogFile.{i}}} instance is CPE implementation specific. Enumeration of: {{enum}} {{reference}} The referenced {{object|##.VendorLogFile.{i}}} instance for the type of log specified by the value of the {{param|Type}} parameter. Data collected from the logging activity. {{numentries}} {{numentries}} This object represents an instance of a Common Service Entity (CSE) for a M2M device or gateway. The {{object}} MAY be maintained by the ACS or by the CPE. When the {{object}} provides the administration of an CSE that is represented as a {{object|.SoftwareModules.ExecutionUnit}} the {{object}} is maintained in the {{param|.SoftwareModules.ExecutionUnit.{i}.References}} parameter. Clause 6.2.9 of the oneM2M Functional Architecture {{bibref|ONEM2MFA}} describes the high level description for CSE registration. {{keys}} Administratively enables or disables this instance. {{datatype|expand}} The CSE-ID of this object. The CSE-ID is required for this {{object}} instance in order for the CSE to register with the registrar CSE defined by the value of the {{param|PointOfAccess}} parameter. The URL of the Registrar CSE to which this {{object}} instance registers for M2M Service Layer operation. The M2M-Ext-ID of the this {{object}} instance. The The Trigger-Recipient-ID of the this {{object}} instance. {{reference|the {{object|#.X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i}}} object instance. The referenced authentication profile is used to convey configuration information regarding establishing mutually-authenticated secure communications}} {{numentries}} {{numentries}} 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 {{object|##.X_oneM2M_org_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 {{param|Type}}. Multiple instances of {{object}} with the same {{param|Type}} is permitted. URI {{bibref|RFC3986}} that represents the identifier of the instance. 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 {{object|##.X_oneM2M_org_CSE}} instance. The {{param}} is an implementation-chosen string that indicates the type of M2M Area Network. {{list}} {{reference}} The list represents the ADN and devices in the M2M Network that are attached to this {{object|##.X_oneM2M_org_CSE}} instance that are within this {{object}} instance. The list does not contain an instance for this CPE. This object provides the administration capability to the CSE for maintenance of ADN and devices in the M2M Network that are attached to this {{object|##.X_oneM2M_org_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 {{object|.Hosts.Host}} table. When the ADN or a device in the M2M Network is managed by the CWMP endpoint of the CPE, the {{object}} is expected to be referenced by an instance of one of the following tables: *{{object|.ManagementServer.EmbeddedDevice}} *{{object|.ManagementServer.VirtualDevice}} 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 {{object|#.M2MAreaNetwork}}. This table contains parameters and information of the ADN or a device in the M2M Network related to each {{object|#.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. {{reference}} {{list}} {{reference|the {{object|.Hosts.Host}} table entry that represents an active or inactive ADN or a device in the M2M Network}} 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. {{list}} {{reference}} References all the {{object|.Hosts.Host}} table entries, whether active or inactive, that represent the reachable neighbors of this ADN or a device in the M2M Network. The interval, in {{units}}, 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 {{param}} for this ADN or a device in the M2M Network in other M2M Area Networks. The duration, in {{units}}, of a sleep period. The value 0 represents an unknown value. Note: When this value is modified, the CPE could modify the {{param}} for this ADN or a device in the M2M Network in other M2M Area Networks. The sleep status of the device. Enumeration of: {{enum}} Whether or not this M2M Device is currently attached to this {{object|##.X_oneM2M_org_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, {{param}} 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. This object represents the Policies and Rules necessary to administer the Communication Management and Delivery Handling (CMDH) functions within a CSE. {{numentries}} {{numentries}} {{numentries}} {{numentries}} {{numentries}} {{numentries}} {{numentries}} {{numentries}} 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 {{bibref|ONEM2MFA}} describes the behavior for CMDH processing. Only one instance of this object shall be enabled for the {{object|###.X_oneM2M_org_CSE.{i}}} instance. Administratively enables or disables this instance. {{datatype|expand}} The name that of this {{object}} instance. {{reference| an {{object|#.Default.{i}}} object instance}} {{list}} {{reference| an {{object|#.Limit.{i}}} object instance}} {{list}} {{reference| an {{object|#.NetworkAccessECRule.{i}}} object instance}} {{list}} {{reference| an {{object|#.Buffer.{i}}} object instance}} 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.2 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for CMDH Default processing. Administratively enables or disables this instance. {{datatype|expand}} {{list}} {{reference| an {{object|#.DefaultECRule.{i}}} object instance}} {{list}} {{reference| an {{object|#.DefaultECParamRule.{i}}} object instance}} 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.3 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for determining the ec based on the rule criteria. Administratively enables or disables this instance. {{datatype|expand}} Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction. The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). Rule criterion. {{list| of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’}} 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 When true, the CSE will establish a subscription to the dynamic context information defined in the {{param|RequestContext}} parameter as well as a subscription to the value of the {{param|EventCategory}} for all AEs corresponding to the AE-ID or an App-ID appearing in the {{param|RequestOrigin}} parameter. 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. Rule result. The value to use for the ec parameter of the request if the conditions expressed in the rule criterion match. 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 {{bibref|ONEM2MFA}} describes the behavior for determining the ec based on the rule criteria. Administratively enables or disables this instance. {{datatype|expand}} {{list}} The applicable Event Categories for which the defaults are used when a request doesn't have a value for request field. Default value, in {{units}}, for the request expiration time parameter (‘rqet’) in a request when the ‘rqet’ attribute of the request is not set. A value of -1 indicates an infinite time. Default value, in {{units}}, for the result expiration time parameter (‘rset’) in a request when the ‘rset’ attribute of the request is not set. A value of -1 indicates an infinite time. Default value, in {{units}}, for the operational execution time parameter (‘oet’) in a request when the ‘oet’ attribute of the request is not set. A value of -1 indicates an infinite time. Default value, in {{units}}, for the response persistence parameter (‘rp’) in a request when the ‘rp’ attribute of the request is not set. A value of -1 indicates an infinite time. Default value for the delivery aggregation parameter (‘da’) in a request when the ‘da’ attribute of the request is not set. 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.5 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for CMDH Limits processing. Administratively enables or disables this instance. {{datatype|expand}} Position of the {{object}} 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 {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction. The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). Rule criterion. {{list| of zero or more local AE-IDs, App-IDs, or the strings ‘localAE’ or ‘thisCSE’}} 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 When true, the CSE will establish a subscription to the dynamic context information defined in the {{param|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 {{param|RequestOrigin}} parameter. 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. Rule Limit. {{list}} Allowed values for the event category parameter (‘ec’) in a request Rule Limit {{list}} Range of allowed values for the request expiration time parameter (‘rqet’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. Rule Limit {{list}} Range of allowed values for the result expiration time parameter (‘rset’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. Rule Limit {{list}} Range of allowed values for the operational execution time parameter(‘oet’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. Rule Limit {{list}} Range of allowed values for the response persistence parameter (‘rp’) in a request. The first entry refers to the minimum time increment and the second entry refers to the maximum time increment. A value of -1 in an entry range is defined as an infinite time. Rule Limit {{list}} Allowed values for the Delivery aggregation parameter (‘da’) in a request. 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.6 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for CMDH Network Access Rule processing for specified event categories. Administratively enables or disables this instance. {{datatype|expand}} Rule Criterion. {{list}} This parameter defines the applicable event categories for which requests the rules contained in {{param|NetworkAccessRules}} are applied. {{list}} {{reference| an {{object|#.NetworkAccessRule.{i}}} object instance}} 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.2.7 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for CMDH Network Access Rule processing. Administratively enables or disables this instance. {{datatype|expand}} Rule Criterion. {{list}} This parameter defines for which underlying networks the usage limits contained in this {{object}} instance is applied. Rule Criterion {{list|the format of schedule entry is defined in {{bibref|ONEM2MProtocol|clause 7.4.9.1}}}} This parameter defines the allowed schedule before any of the Underlying Networks matching a value in the {{param|TargetNetworks}} parameter can be used for forwarding information to other CSEs. Rule Criterion This parameter defines the minimum amount of data, in {{units}}, that needs to be aggregated before any of the Underlying Networks matching a value in the {{param|TargetNetworks}} parameter can be used for forwarding information to other CSEs. Rule Criterion This parameter defines the vendor specific criteria that can be applied this object. Rule Result This parameter defines the time, in {{units}}, that defines how long a CSE needs to wait before attempting to use a specific Underlying Network again after a first failed attempt. Rule Result This parameter defines by how much, in {{units}}, the back-off time shall be increased after each additional consecutive failed attempt to use the same Underlying Network without success. Rule Result This parameter defines the time, in {{units}}, that defines the maximum wait time before attempting to use an Underlying Network again after previous failures. 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.8 of the M2M Functional Architecture {{bibref|ONEM2MFA}} describes the behavior for CMDH Buffer processing. Administratively enables or disables this instance. {{datatype|expand}} Rule Limit. {{list}} Allowed values for the event category parameter (‘ec’) in a request Rule Limit Maximum amount of memory, in {{units}}, that can be used for buffering requests matching with a value in the {{param|EventCategories}} parameter. Rule Result Storage priority for data that is stored for buffering requests matching with this {{object}} instance This object represents an instance of a Application Entity (AE) for a M2M device or gateway. The {{object}} MAY be maintained by the ACS or by the CPE. When the {{object}} provides the administration of an CSE that is represented as a {{object|.SoftwareModules.ExecutionUnit}} the {{object}} is maintained in the {{param|.SoftwareModules.ExecutionUnit.{i}.References}} parameter. Clause 6.2.9 of the oneM2M Functional Architecture {{bibref|ONEM2MFA}} describes the high level description for CSE registration. {{keys}} Administratively enables or disables this instance. {{datatype|expand}} The AE identifier of this object. The AE-ID is required for this {{object}} instance in order for the AE to register with the registrar CSE defined by the value of the {{param|PointOfAccess}} parameter. The URL of the Registrar CSE to which this {{object}} instance registers for M2M Service Layer operation. The APP-ID of this {{object}} instance. {{reference|the {{object|#.X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i}}} object instance. The referenced authentication profile is used to convey configuration information regarding establishing mutually-authenticated secure communications}} This object represents the data collection (measurement) and transmittal (reporting) properties for an AE. URI {{bibref|RFC3986}} of the container resource in the Hosting CSE that stores the data transmitted by this {{object}} instance. {{list|the format of schedule entry is defined in {{bibref|ONEM2MProtocol|clause 7.4.9.1}}}} This parameter defines the schedule used to transmit the data that was collected. {{list|the format of schedule entry is defined in {{bibref|ONEM2MProtocol|clause 7.4.9.1}}}} This parameter defines the schedule used to collect the data for transmission. This parameter represents a hash value for identifying the certificate to be used by the intended security principal on the Managed Entity to authenticate itself to other security principals. The hash value is computed over the X.509 ASN.1 DER encoded certificate using the sha-256 hash algorithm as specified in {{bibref|IETF-HASH}}. The format of the parameter value is defined in {{bibref|ONEM2MDeviceConfig|clause 7.3.2}}. This parameter represents the media type format of the {{object}} instance. {{list| each entry is a Security Usage Identifier (SUID) of the security framework used for establishing mutually-authenticated secure communication}} A SUID which is not in this list is prevented from using this credential for establishing mutually-authenticated secure communication. This object represents the oneM2M specific security solutions used by CSEs and AEs as defined in defined in {{bibref|ONEM2MSecurity}}. {{numentries}} {{numentries}} {{numentries}} This object represents an instance of a Authentication Profile that defines the method and information needed to establish mutually authenticated secure communications as defined in {{bibref|ONEM2MDeviceConfig|clause 7.1.4}}. Administratively enables or disables this instance. {{datatype|expand}} The Security Usage Identifier (SUID) that represents this {{object}} instance that describes how this {{object}} instance is to be used in the authentication process. The values for this parameter are defined in {{bibref|ONEM2MDeviceConfig|clause 7.1.5}}. {{list|when the {{param|SUID}} indicates a use for TLS. This parameter provides a list of permitted TLS ciphersuites that can be used in the authentication process}} The formatting of the cipher suite is defined in {{bibref|ONEM2MDeviceConfig|clause 7.3.2}}. The identifier for the symmetric key that the entity uses to authenticate the peer entity. The format of the identifier is defined in {{bibref|ONEM2MSecurity|clause 12.2}}. {{list|the value of the key}} The Fully Qualified Domain Name (FQDN) of the element to which this M2M Authentication (MAF) client will communicate in order to register its keys used in the M2M authentication function (MAF). The duration, in {{units}}, that represents the expiration period for the key that is registered with the MAF by this MAF client. The value 0 represents an infinite duration. {{reference|the {{object|##.Security.Certificate.{i}}} object instance. The referenced certificate is intended security principal on the Managed Entity to authenticate itself to other security principals}} The identifier to authenticate other security prinicipals when the other security principal authenticate itself with a Raw Public Key Certificate. The format of the parameter value is defined in {{bibref|ONEM2MDeviceConfig|clause 7.3.2}}. {{list|{{reference|the {{object|##.TrustAnchorCredential.{i}}} object instance. The referenced credential is intended security principal on the Managed Entity to authenticate other security principals that present certificates}}}} This object represents an instance of a Authentication Profile that defines the method and information needed to establish mutually authenticated secure communications as defined in {{bibref|ONEM2MDeviceConfig|clause 7.1.4}}. Administratively enables or disables this instance. {{datatype|expand}} This parameter represents a hash value for identifying the certificate to be used by the intended security principal on the Managed Entity to authenticate other security principals. The hash value is computed over the X.509 ASN.1 DER encoded certificate using the sha-256 hash algorithm as specified in {{bibref|IETF-HASH}}. The format of the parameter value is defined in {{bibref|ONEM2MDeviceConfig|clause 7.3.2}}. The URI {{bibref|RFC3986}} that represents the identifier of the remote trust store from which the Managed Entity can retrieve the CA Certificate if the certificate is not locally stored. This object represents an instance of a configuration object needed for the MAF Client to mutually authenticate with a MAF as defined in {{bibref|ONEM2MSecurity|clause 8.8.3}}. Administratively enables or disables this instance. {{datatype|expand}} {{reference|the {{object|#.AuthenticationProfile.{i}}} object instance containing the infromation for this {{object}} instance to authenticate with the MAF}} The URI {{bibref|RFC3986}} that represents address to which MAF client will send the registration request. The port that MAF will be listening on when the communication uses the HTTP protocol. The port that MAF will be listening on when the communication uses the HTTP protocol. The port that MAF will be listening on when the communication uses the Websocket protocol. Time at which the registration will expire.