TR-069 Device:2.6 Root Object definition November 2012 TR-181 Issue 2 Amendment 6 Classification criterion. Destination IP address. {{empty}} indicates this criterion is not used for classification. Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and, if specified, MUST be ignored). If {{false}}, the class includes only those packets that match the (masked) DestIP entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) DestIP entry, if specified. Classification criterion. Source IP address. {{empty}} indicates this criterion is not used for classification. Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). If {{false}}, the class includes only those packets that match the (masked) {{param|SourceIP}} entry, if specified. If {{true}}, the class includes all packets except those that match the (masked) {{param|SourceIP}} entry, if specified. Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. If {{false}}, the class includes only those packets that match the {{param|Protocol}} entry, if specified. If {{true}}, the class includes all packets except those that match the {{param|Protocol}} entry, if specified. Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. Classification criterion. If specified, indicates the classification criterion is to include the port range from {{param|DestPort}} through {{param}} (inclusive). If specified, {{param}} MUST be greater than or equal to {{param|DestPort}}. A value of -1 indicates that no port range is specified. If {{false}}, the class includes only those packets that match the {{param|DestPort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|DestPort}} entry (or port range), if specified. Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. Classification criterion. If specified, indicates the classification criterion is to include the port range from {{param|SourcePort}} through {{param}} (inclusive). If specified, {{param}} MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. If {{false}}, the class includes only those packets that match the {{param|SourcePort}} entry (or port range), if specified. If {{true}}, the class includes all packets except those that match the {{param|SourcePort}} entry (or port range), if specified. The {{object}} object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture {{bibref|ETSIM2MFA}}. {{numentries}} This object represents an instance of a Service Capability Layer (SCL) 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 SCL that is represented as a {{object|.SoftwareModules.ExecutionUnit}} the {{object}} is maintained in the {{param|.SoftwareModules.ExecutionUnit.{i}.References}} parameter. Section 5.1.2 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the high level event flows for SCL registration. Section 9.3.2.6.2 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the creation/registration of SCLs. Section 9.3.2.6.4 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the update/re-registration of SCLs. Section 9.3.2.6.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the deletion/deregistration of SCLs. {{keys}} Administratively enables or disables this instance. {{datatype|expand}} {{list}} The list represents an unordered set of URIs {{bibref|RFC3986}}. A list item is a URI string that represents a SCL to which the this {{object}} will announce original (local) resources. The AnnouncedToSCL has an interest in the discovery of the local resource. Section 9.2.1.14 Announced Resource of the M2M Functional Architecture {{bibref|ETSIM2MFA}} provides a description of this behavior of an Announced Resource. Section 9.3.2.28 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} and Section 10.3.2.7 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} describes the process of announcing and deannouncing of resources within a SCL. {{numentries}} {{numentries}} {{numentries}} This object is represents the administration properties used when a NSCL requests discovery of resources within this {{object|##.SCL}} instance. Section 9.3.2.27 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the process of discovery of resources within a SCL. The maximum number of URIs {{bibref|RFC3986}} for discovered resources contained in a discovery result. This parameter and the {{param|MaxSizeOfDiscovAnswer}} parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter. A value of 0 indicates that the SCL does not have a limit for this parameter. The maximum size in bytes of the Discovery Answer. This parameter and the {{param|MaxNumberOfDiscovRecords}} parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter. A value of 0 indicates that the SCL does not have a limit for this parameter. This object represents the properties and status necessary for a SCL to reregister with one or more NSCLs. {{list}} The list represents a priority ordered set of URIs {{bibref|RFC3986}}. The item that is first in the list has the highest priority. A list item is a URI {{bibref|RFC3986}} string that represents a NSCL that this {{object|##.SCL}} instance can use in order to attempt registration. When modified the contents of this parameter replace the {{param}} received during the bootstrap procedure. {{list}} The list represents the string tokens used as keys when searching for this {{object|##.SCL}} instance. Sections 9.2.3.6.2 and 9.2.3.6.4 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describe the usage for this parameter. URI {{bibref|RFC3986}} that represents the identifier of the access right resource. The value of this parameter is maintained by the NSCL and used by the SCL as a default access right identifier for re-registration to NSCLs. The duration, in {{units}}, that the SCL will use in its next re-registration attempt. Any negative value represents an infinite duration. {{command}} When set to {{true}}, triggers an immediate re-registration action where the SCL re-registers with the SCLs in the {{param|RegTargetNSCLList}} . This object represents the status of the Reregistration action. The progress, in {{units}}, of the Reregistration action. The progress is measured from 0-100%. A value of 0 indicates that the action has not started. A value of 100 indicates that the action has completed. The completion status of the Reregistration operation. Enumeration of: {{enum}} This object describes the parameters necessary to administer the store-and-forward (SAF) handling policies applied to requests to access remotely hosted resources. Policies are described by instances of {{object}}. Which instances of {{object}} are used by the SCL is determined by the {{param|PolicyScope}} parameter. Section 9.3.1.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} and Section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} describe the behavior for SAF processing. There is at most one {{object}} instance with the {{param|PolicyScope}} containing a specific application id (APP-ID) URI value within the list. There is exactly one {{object}} instance with a {{param|PolicyScope}} value of "default". Administratively enables or disables this instance. {{datatype|expand}} The parameter defines the scope of the policies contained in this instance of a {{object|#.SAFPolicySet}}. The parameter value is: *a list of unordered set of URIs {{bibref|RFC3986}} that represents an M2M application id (APP-ID) *the value of "default" *{{empty}} When this parameter is set to a list of application id (APP-ID) URIs {{bibref|RFC3986}}, the scope indicates that the policies are applicable to requests coming from any specific application on that list. When this parameter is set to a string with the value "default", the scope indicates that the policies are the default policies for this {{object|##.SCL}} instance. When this parameter is set to {{empty}}, the value represents an unknown {{object|#.SAFPolicySet}} and the {{object|#.SAFPolicySet}} is not to be used. {{numentries}} This table contains the SAF-handling policies which are controlled by the Access Network Provider(s). {{keys}} Administratively enables or disables this instance. {{datatype|expand}} This parameter is the name of the access network provider and used to determine for which access network the policies defined in the {{object|#.ANPPolicy}} table will apply. {{numentries}} {{numentries}} This table contains a list of block periods for a {{object|##.ANPPolicy}}. A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed. Administratively enables or disables this instance. {{datatype|expand}} Number of consecutively failed access attempts for which the {{param|BlockDuration}} will be used to block the next access attempt. The SCL will apply the {{object}} entry with the largest number of consecutive failed attempts that is smaller or equal to the actual number of consecutive failed attempts. The duration, in {{units}}, to which to block further access attempts. This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests. Administratively enables or disables this instance. {{datatype|expand}} An RCAT is a string that represents a request category used for policy enforcement. {{numentries}} This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the {{param|#.RCAT}}. The combination of all instances of the {{object|AbsTimeSpan}} along with the {{param|Schedules}} parameter makes up the complete schedule for this instance of a {{object}}. The {{param|Schedules}} parameter defines a recurrence of the schedule. If instances of {{object|AbsTimeSpan}} exist, these instances places constraints on the schedule recurrence. If the value of the {{param|Schedules}} parameter is {{empty}}, at least one enabled instance of {{object|AbsTimeSpan}} MUST exist. Processing behavior for the use of RCAT Schedules is defined in section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} document. Administratively enables or disables this instance. {{datatype|expand}} The list is a set of schedule strings. A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in {{bibref|POSIXBase}}. The {{param}} parameter is used to set the recurrence of the schedule. The timezone used for this parameter is dependent upon the existence of instances of {{object|AbsTimeSpan}} for this {{object}}. If instances of {{object|AbsTimeSpan}} exist, then the timezone of the {{object|AbsTimeSpan}} is used otherwise the UTC timezone is used for this {{param}} parameter. Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in {{bibref|TR-106a5|section 3.2.3}} Example of CRONTAB string: *"* 0-6 * * 1-5" would mean every minute for the period from 0:00h to 6:00h (inclusive) on any week day (Monday through Friday) and would be represented as "*%200-6%20*%20*%201-5" *"*/15 22-23,0-4 * * 1-5" would mean every 15 minutes for the period from 22:00h to 04:00h on any week day (Monday through Friday) and would be represented as "*/15%2022-23%2C0-4%20*%20*%201-5" {{numentries}} This object defines an instance of a time span used for determining an RCAT schedule. An instance of the {{object}} represents the time span in which the schedule recurrence defined in {{param|#.Schedules}} is constrained. {{object}} instances with unknown values for the {{param|StartTime}} or {{param|EndTime}} are ignored. All instances of the {{object}} within this {{object|##.Schedule}} MUST utilize the same time zone. Administratively enables or disables this instance. {{datatype|expand}} Date and time that represents the start of the time span. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the {{param}} value greater than the {{param|EndTime}} value. Date and time that represents the end of the time span. The value 9999-12-31T23:59:59Z represents an infinite time span from the start time. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the {{param}} value less than or equal the {{param|StartTime}} value. This object maintains the SAF handling policies' properties that are controlled by the M2M service provider for a request. The default RCAT value to use for requests to remotely hosted resources during SAF-handling when no RCAT value was specified in the request. {{numentries}} This object maintains a list of properties to be used for forwarding requests with a specified {{param|RCAT}}. Processing behavior for the use of M2M Service Provider policies is defined in section 10.3.1.2.2.1 of the M2M mIa, dIa and mId Interfaces {{bibref|ETSIM2MInterfaces}} document. Administratively enables or disables this instance. {{datatype|expand}} An RCAT is a string that represents a request category used for policy enforcement. The tolerable duration, in {{units}}, that a request of the given RCAT category can be pending in SAF handling when a request from an M2M Application does not specify a tolerable delay. A value of -1 represents an infinite duration. The threshold of maximum number of pending requests permitted to be held for a specified RCAT. A value of 0 indicates that the request should be transmitted immediately. This parameter defines the maximum size of the request queue for pending requests permitted to be held for a specified RCAT. The format of the string is an integer with an appended memory unit (B - Bytes, K - 1024 Bytes, M - 1048576 Bytes, G -1073741824, T - 1099511627776 Bytes). When the value is {{empty}} the memory threshold criteria for the associated RCATList will be ignored in SAF handling. {{pattern}} {{empty}} The list is a prioritized set of Access Networks where the preference of using an Access Network is based on order of the list items with the lowest order list item as the most preferred Access Network. The M2M Area Network information provides administration capabilities for remote management (REM) of M2M Devices (D', d) that are attached to this {{object|##.SCL}} instance. This object provides the administration of the properties needed by the SCL to remotely manage M2M Devices within a specific type of M2M Area network as defined by {{param|AreaNwkType}}. Multiple instances of {{object}} with the same {{param|AreaNwkType}} is permitted. Section 5.3.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the REM functionality expected of a SCL for an M2M Device. URI {{bibref|RFC3986}} that represents the identifier of the instance. Devices (D' and d) that connect to an SCL are said to be "attached devices" and are organized by M2M Area Networks within the {{object|##.SCL}} instance. The {{param}} is an implementation-chosen string that indicates the type of M2M Area Network. {{list}} {{reference}} The list represents the M2M Devices (D', d) that are attached to this {{object|##.SCL}} instance that are within this {{object}} instance. The list does not contain an instance for this CPE. {{numentries}} This object contains an instance of a property extension (name value pair) for this {{object|##.AreaNwkInstance}} instance. For example, if the {{param|#.AreaNwkType}} is ZigBee the {{object|##.AreaNwkInstance}} will contain ZigBee specific parameters that have not been modeled for the M2M Area network. At a minimum, a property instance MUST exist that defines an attribute that describes the IP layer address type (e.g., IPv4, IPv6, non-IP) of this M2M Area Network. The name of the property The value of the property. The M2M Area Network Device Information provides the administration capability to the SCL for maintenance of M2M Devices (D', d) that are attached to this {{object|##.SCL}} 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 M2M Device 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}} Section 5.3.5 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes the REM functionality expected of a SCL to a M2M Device. This object instance provides the administration properties required by a SCL to remotely manage an instance of a M2M Device within a M2M area network. A M2M Device is associated with an instance of a {{object|#.AreaNwkInstance}}. This table contains parameters and information of the M2M Device related to each {{object|#.AreaNwkInstance}} 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 M2M Device}} {{list}} {{reference}} References all the {{object|.Hosts.Host}} table entries, whether active or inactive, that represent the reachable neighbors of this M2M Device (D' or d). The list is an unordered set of URIs {{bibref|RFC3986}}. A list item is an URI string that represents an application id (APP-ID) for the M2M D'A applications residing on the M2M Device for the associated {{object|#.AreaNwkInstance}}. Table B.58 of the M2M Functional Architecture {{bibref|ETSIM2MFA}} describes this parameter. 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 M2M Device in other 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 M2M Device in other Area Networks. The sleep status of the device. Enumeration of: {{enum}} Whether or not this M2M Device is currently attached to this {{object|##.SCL}} instance. The ability to list inactive M2M Devices is OPTIONAL. If the CPE includes inactive M2MDevices in this table, {{param}} is set to {{false}} for each inactive M2M Device. The length of time an inactive M2M Device remains listed in this table is a local matter to the CPE. {{numentries}} This object contains an instance of a property extension (name value pair) for this {{object|##.AreaNwkDeviceInfoInstance}} instance. For example, if the {{param|##.AreaNwkInstance.{i}.AreaNwkType}} value is ZigBee, this {{object|##.AreaNwkDeviceInfoInstance}} contains ZigBee-specific parameters that are not formally modeled for this {{object|##.AreaNwkDeviceInfoInstance}} instance. The name of the property The value of the property. The Firewall implements stateful packet inspection. Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and, if specified, MUST be ignored). Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and, if specified, MUST be ignored). Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and, if specified, MUST be ignored). Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be {{empty}} (and, if specified, MUST be ignored). Properties for Domain Name Service (DNS).