{{docname|Device:2 Root Data Model for USP (TR-369)}}
{{appdate|March 2018}}
{{trname|TR-181i2a12}}
* Added USP Local agent support (TR-369)
* Added Firmware Image support
* Added Ethernet Link Aggregation Group
* Added additional Wi-Fi and WAN statistics
* Added support for Two-Way Active Measurement Protocol (TWAMP) reflector
* Added support for Layer Two Tunneling Protocol version 3 (L2TPv3)
* Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels
* Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM)
* Added support for Large-Scale Measurement of Broadband Performance (LMAP)
A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.
The following mandatory constraints MUST be enforced:
* The value MUST NOT be empty.
* The value MUST start with a letter.
* If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.
The value MUST NOT change once it's been assigned.
{{numentries}}
Reboot the entity associated with the containing {{object}}.
Boot event indicating that the {{object}} was rebooted.
The ''command_key'' supplied when requesting the boot, or {{empty}} if the boot was not requested via a USP operation.
The cause of the boot.
{{true}} if the firmware was updated as a result of the boot that caused this Event Notification; otherwise {{false}}.
Boot parameters configured via the recipient Controller's {{object|.LocalAgent.Controller.{i}.BootParameter}} table.
Formatted as a {{datatype|expand}}
Factory reset the entity associated with the containing {{object}}.
This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.
Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
The friendly name of the device.
In {{bibref|TR-369}} the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of {{bibref|TR-369}}.
Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. {{pattern}}
This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number.
This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the {{object|.DeviceInfo}} object.
NOTE: The Vendor Log File table ({{object|.DeviceInfo.VendorLogFile}}) details are located on the {{object|.DeviceInfo}} object.
The unique USP identifier for this USP Agent.
The current USP Agent software version; not the version of the overall device firmware, which is located in {{param|.DeviceInfo.SoftwareVersion}}.
To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''.
Time in {{units}} since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device).
Periodic event configured via the recipient Controller's {{param|Controller.{i}.PeriodicNotifInterval}} and {{param|Controller.{i}.PeriodicNotifTime}} parameters.
Wake-up event.
Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case {{param|FaultCode}} will be zero), or else has failed (in which case {{param|FaultCode}} will be non-zero and {{param|FaultString}} will give further details).
The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation {{param|Command}}, {{param|CommandKey}} and {{param|Requestor}} give further details.
The Path Name of the command that requested the transfer, or {{empty}} if the transfer was not requested via a USP operation.
The ''command_key'' supplied when requesting the transfer, or {{empty}} if the transfer was not requested via a USP operation.
The Endpoint ID of the Controller that requested the transfer, or {{empty}} if no Controller requested it.
The type (direction) of the transfer.
Downstream transfer; to the Agent.
Upstream transfer; from the Agent.
The Path Name of the Object or Object Instance that was affected by the transfer, or {{empty}} if no data model object was affected by the transfer.
The URL from or to which this transfer was performed, or {{empty}} if no such URL is available.
The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the ''Unknown Time'' value.
The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the ''Unknown Time'' value.
The numerical fault code as defined in {{bibref|TR-369}}. A value of 0 (zero) indicates no fault.
A human-readable text description of the fault. This field SHOULD be {{empty}} if the {{param|FaultCode}} equals 0 (zero).
This command is issued to allow a Controller (with the proper permissions) to add a new certificate to {{object|#.Certificate.{i}}}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in {{param|#.Controller.{i}.Credential}} or {{param|#.ControllerTrust.Credential.{i}.Credential}} that references the new {{object|#.Certificate.{i}}} entry. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted.
An optional input the Controller can use to specify the {{param|##.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|##.Certificate.{i}}}, this commmand will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format.
USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol.
See {{bibref|RFC7252}}
See {{bibref|RFC6455}}
See {{bibref|STOMP1.2}}
{{list|each entry is an algorithm for calculating firgerprints that is supported by the Agent}}
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
{{list|each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in {{bibref|RFC6762}}}}
The acceptable amount of time in {{units}} between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered.
For example, if this parameter is set to 30 {{units}}, then once a Subscription has been updated, the Agent has 30 {{units}} before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription).
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
Each instance of this table represents a MTP used by the local Agent.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.
The current operational state of the {{object}} instance.
Value when this {{object}} instance cannot establish communication.
Value when this {{object}} instance is misconfigured.
The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint.
This parameter, when {{true}}, enables the advertisement of DNS-SD services defined for this {{object}} instance using mDNS as defined in {{bibref|RFC6762}}.
This parameter cannot be set to {{true}} if there are multiple {{object}} instances with the same value of the {{param|Protocol}} parameter.
When {{true}}, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN).
The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this {{object}} instance and the interfaces defined by the {{param|##.DNS.SD.AdvertisedInterfaces}} parameter.
Each instance of this table represents a USP Controller that has access to this USP Agent.
{{datatype|expand}}
The unique USP identifier for this USP Controller.
Information about the configuration state of an Agent as it pertains to the {{object}} instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in {{param|ProvisioningCode}}.
This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent's configuration, allowing the Controller to streamline the configuration process.
Identifying information which MAY be used by the {{object}} instance to determine {{object}} instance specific customization and provisioning parameters.
Enable/Disable this {{object}} instance.
When {{false}}, messages (notifications) are not sent to the remote endpoint represented by this {{object}} instance.
{{list|each entry is a Role that has been assigned to this {{object}} instance by means other than the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter}}
{{list|each entry is a Role that has been assigned to this {{object}} instance from the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter associated with the CA credential ({{param|.LocalAgent.ControllerTrust.Credential.{i}.Credential}}) used to validate the Controller certificate}}
{{nolist}}
Comma-separated list of strings, the set of certificates from {{object|#.Certificate.{i}}} that a Controller can present for use in authenticating the identity of this {{object}} instance.
If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is the duration in {{units}} of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller.
If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicNotifInterval}}.
{{param}} is used only to set the ''phase'' of the Periodic Event Notifications. The actual value of {{param}} can be arbitrarily far into the past or future.
For example, if {{param|PeriodicNotifInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future.
The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified {{param|PeriodicNotifInterval}}.
If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.
This parameter is related to the retry mechanism for Notifications.
Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}.
A value of 5 corresponds to the default behavior.
The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|USPNotifRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
This parameter is related to the retry mechanism for Notifications.
Configures the retry interval multiplier as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}.
This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
A value of 2000 corresponds to the default behavior.
The USP Agent MUST use a random value between {{param|USPNotifRetryMinimumWaitInterval}} and ({{param|USPNotifRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
Schedule a ''Timer!'' event on the associated {{object}}.
The number of seconds from the time this command is invoked until the Agent initiates a Timer! Event notification (based on the associated subscriptions).
Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message.
The ''command_key'' supplied when requesting the timer event.
This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in {{object|#.Certificate}} and adds a reference to the new entry to the Controller's {{param|#.Controller.{i}.Credential}}. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted.
An optional input the Controller can use to specify the {{param|###.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|###.Certificate.{i}}}, this commmand will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format.
Requests the Agent to send an ''OnBoardRequest'' notification to this Controller.
{{numentries}}
{{numentries}}
Each instance of this table represents a MTP used by this Controller.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.
The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint.
The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers.
Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller.
The autonomous file transfer completed successfully; i.e., the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was zero
The autonomous file transfer did not complete successfully; i.e., the the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was non-zero
Success and Failure
This table provides the Controller with the ability to dictate the Parameters that are delivered via ''Boot!'' events.
Any Parameter (identified by {{param|ParameterName}}) contained in this table MUST be included within the ''param_map'' element of the ''Boot!'' event.
{{datatype|expand}}
Enables or disables this {{object}}.
A pattern that describes the Parameter(s) to be included in the ''param_map'' element of a ''Boot!'' event. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed.
If the pattern does not match any existing Parameters at the time that the Agent is creating the ''Boot!'' event, then this {{object|#.BootParameter}} instance is not included in the ''param_map'' of the ''Boot!'' event.
The {{object}} object represents the End to End (E2E) Session Context functionality for this {{object|##.Controller.{i}}} object instance.
Enable/Disable this {{object}} instance.
When {{true}}, Session Context is used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance.
When {{false}}, Session Context is not used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance.
The current status of the Session Context.
A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received).
The duration in {{units}} in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart).
A value of 0 means session expiration is disabled.
Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}.
A value of 5 corresponds to the default behavior that is described in {{bibref|TR-369}}.
The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
Configures the retry interval multiplier as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}.
This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
A value of 2000 corresponds to the default behavior that is described in {{bibref|TR-369}}.
The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state.
The maximum size, in {{units}}, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes.
A value of 0 means that the segmentation function is effectively disabled.
The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint.
If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session.
A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record.
A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session.
The security mechanism to use when exchanging the payload of the Record with the remote endpoint.
The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS.
The procedures for using TLS in a Session Context is defined in {{bibref|TR-369}}.
If the {{object}} is enabled then this command will either request to start or restart a Session Context with the remote endpoint.
If the {{object}} is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint.
If the {{object}} is not enabled and there is no active Session Context then this command does nothing.
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters.
{{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}}
{{empty}} will bind this server to all interfaces for this device.
The port number used by the CoAP Server to receive USP messages.
The path that is used by the CoAP Server in order to receive USP messages.
This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted.
When {{true}}, encryption is used for this MTP instance.
If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters.
The hostname or IP Address of the Controller's CoAP server.
The port number used by the Controller's CoAP Server to receive USP messages.
The path that is used by the Controller's CoAP Server in order to receive USP messages.
When {{true}}, encryption is used as specified in {{bibref|TR-369|Section "MTP Message Encryption"}}.
If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server.
A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP.
The STOMP destination where the Agent will be listening to incoming USP messages.
The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame.
If the Agent doesn't receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter is {{empty}}.
If this parameter's value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the {{param|Destination}} Parameter contains the STOMP destination address for this Agent.
If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server.
A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP.
The STOMP destination where the Controller will be listening to incoming USP messages.
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters.
{{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}}
{{empty}} will bind this server to all interfaces for this device.
The port number used by the WebSocket Server to receive USP messages.
The path that is used by the WebSocket Server in order to receive USP messages.
If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters.
The hostname or IP Address of the Controller's WebSocket server.
The port number used by the Controller's WebSocket server to receive USP messages.
The path that is used by the Controller's WebSocket server in order to receive USP messages.
This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted.
The the duration in {{units}} between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller.
The current retry count of the session. When zero (0), the session is not in a retry state.
Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}.
The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
Configures the retry interval multiplier as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}.
This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
If enabled, this command will either request to start or restart an WebSocket session with the Controller.
A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller.
{{datatype|expand}}
Enables/disables this {{object}}. A disabled entry MUST NOT be processed by the USP Agent.
{{reference|the {{object|#.Controller}} instance that will receive the Notification associated with this {{object}}|delete}}
The value of this parameter is automatically populated by the USP Agent upon {{object}} creation using the reference to the USP Controller that created the instance.
Unique identifier of the {{object}} itself, which is specific to the USP Controller that creates the instance of the {{object}}.
This value is also populated in the ''subscription_id'' element of every Notification message sent from a USP Agent to a USP Controller.
The date and time when this instance of {{object}} was created. This is internally used by the {{param|TimeToLive}} parameter to determine the expiration of this {{object}} instance.
The value of this parameter is automatically populated by the USP Agent upon {{object}} creation.
Type of Notification message that will be sent to the USP Controller specified by {{param|Recipient}} when this {{object}} is triggered.
Each entry in the list is a parameter path that determines the element of the data model that the {{object}} is applicable to.
Different values of the {{param|NotifType}} parameter will cause the {{object}} to interact with {{param}} differently. For example, an instance of {{object}} with {{enum|ValueChange|NotifType}} will utilize the value of this parameter differently than an instance with {{enum|Event|NotifType}}.
Expressions are allowed in the list items, but in some cases could cause a dynamic set of instances to be monitored in order to fulfill the Subscription's requirements.
Once the value of the {{param}} is written, the value cannot be changed as the {{object}} instance is considered to be immutable. If the value of a non-empty {{param}} parameter needs to change, the {{object}} instance MUST be deleted and a new {{object}} instance created.
Determines whether or not this {{object}} remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).
If {{true}}, this {{object}} stays in existence until either a Delete message removes it or the {{param|TimeToLive}} parameter expires.
If {{false}}, this {{object}} is automatically removed by the USP Agent whenever it is restarted.
Specifies the duration of time (in {{units}}) that this {{object}} remains in existence. After {{param}} has expired, this {{object}} instance is automatically removed by the USP Agent.
If the value of {{param}} is 0, then this parameter is ignored and this {{object}} stays in existence until either a Delete message removes it or the {{param|Persistent}} parameter determines that it needs to be removed.
If the value of {{param}} is greater than 0, then this parameter determines the length of time (from {{object}} creation) until it will be automatically removed by the USP Agent (unless the {{param|Persistent}} parameter is {{false}} and the USP Agent is restarted, in which case it will be removed before the {{param}} expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.
If the USP Agent is incapable of maintaining absolute time then {{param}} will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before {{param}} expiration.
Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller.
When {{param}} is {{true}}, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the "send_resp" flag set to {{true}} such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}.
When {{param}} is {{false}}, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with "send_resp" flag set to {{false}}.
Specifies the duration of time (in {{units}}) that the Notification associated with this {{object}} will continue to be retried. After {{param}} has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification.
If {{param|NotifRetry}} is set to {{false}} then this parameter is ignored.
If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).
If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).
NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.
{{object}} instances are created using USP ''Operate'' messages. Only ''Operate'' messages with ''async''=''true'' will create a {{object}} instance in the data model.
When the command of the ''Operate'' completes, then this {{object}} instance is removed from this table.
{{datatype|expand}}
The USP Endpoint Identifier that originated the command.
The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance.
The command is a result of the evaluation of the ''command'' argument of an ''Operate'' message.
The ''command_key'' from the USP ''Operate'' message.
The operational status of the request to execute the command.
The command has been requested but is currently not executing.
The command is currently executing.
The command has been requested to be canceled.
The command has successfully been canceled.
The command has successfully been completed its execution.
The command has unsuccessfully completed its execution or has unsuccessfully been canceled.
Request cancelation of this {{object}}'s command.
This command completes immediately. If successful, {{param|Status}} will immediately change to {{enum|Canceling|Status}} and will change to {{enum|Canceled|Status}} when the cancelation is complete.
Each instance of this table represents information related to a X.509 certificate (see {{bibref|RFC5280}}) of a Controller or Certificate Authority. Instances are referenced from {{param|##.LocalAgent.Controller.{i}.Credential}} and {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}}.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
The Serial Number field in an X.509 certificate, see {{bibref|RFC5280}}.
The Issuer field in an X.509 certificate, see {{bibref|RFC5280}}; i.e. the Distinguished Name (DN) of the entity who has signed the certificate.
This command is issued to allow a Controller (with the proper permissions) to delete an entry from the {{object|##.Certificate.{i}}}. It also removes references to the Certificate in {{param|##.LocalAgent.Controller.{i}.Credential}} or {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}} and removes any X.509 certificate data the Agent had stored related to the entry.
This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input {{param|FingerprintAlgorithm}}.
The algorithm to be used to calculate the requested fingerprint. The value MUST be one the Agent supports, as noted in {{param|###.SupportedFingerprintAlgorithms}}.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
The value of the fingerprint.
This object contains information that an Agent applies when establishing a trust relationship with a Controller.
{{list|each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the {{param}} parameter is appended to the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter}}
In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter.
The Role that is associated with Controllers indicate banned access.
When assigned to a Controller or associated with an entry in the {{object|Credential}} table, this MUST be the only value of the {{param}} parameter of the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter.
The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role.
When {{true}}, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU).
Inactivity timer in {{units}}.
This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session.
A value of 0 means that the TOFU inactivity timer is effectively disabled.
This command is issued to retrieve the instruction for the referenced challenge.
There is at most one (1) outstanding RequestChallenge for a requesting Controller.
As such, any new challenges with a different value of the {{param|ChallengeRef}} parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires.
When the value of the {{param|ChallengeRef}} parameter defined in the RequestChallenge does not exist, the Agent returns an "Invalid Value" error.
{{reference|the {{object|#.Challenge}} object instance for this request}}
The expiration period, in {{units}}, where the Controller request that this challenge request expire (times-out).
A value of zero indicates that the challenge request will never expire. The default is 900 {{units}}.
The value of the {{param|##.Challenge.{i}.Instruction}} parameter associated with the requested challenge in the {{param|#.Input.ChallengeRef}} parameter.
The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter.
The allowable values of the media type are defined by the {{param|##.Challenge.{i}.InstructionType}} parameter.
The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|##.Challenge.{i}.Value}} parameter.
The allowable values of the media type are defined by the {{param|##.Challenge.{i}.ValueType}} parameter.
The challenge identifier the Controller uses in the ChallengeResponse command to correlate this request with a response.
This command is issued to return the response of challenge.
The challenge identifier the Controller uses to correlate the challenge request with a response.
The value of the challenge that is specific to the type of challenge. The challenge value is provided by the external party to the Controller.
{{numentries}}
{{numentries}}
{{numentries}}
Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model.
If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
The Role assigned to this {{object}} instance.
{{numentries}}
Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role.
If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same {{object|#.}}.
The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority).
{{list|each entry is a target to which the value of the permissions parameters are assigned}}
When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter.
When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance.
When an entry is a value of a Search Path as defined in {{bibref|TR-369}} that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this {{object}} instance.
The permissions of a Role for the specified Targets.
A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).
The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).
The following describes the meaning of the permissions for Parameter type of Targets:
# Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM.
# Write: Grants the capability to update the value of the Parameter via Add or Set.
# Execute: Grants no capabilities; Parameters can not be executed.
# Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription.
The permissions of a Role for the specified Targets.
A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).
The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).
The following describes the meaning of the permissions for Object type of Targets:
# Read: Grants the capability to read the meta-information of the Object via GetSupportedDM.
# Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.).
# Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions.
# Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription.
The permissions of a Role for the specified Targets.
A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).
The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).
The following describes the meaning of the permissions for Instantiated Object type of Targets:
# Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances.
# Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
# Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
# Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription.
The permissions of a Role for the specified Targets.
A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).
The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).
The following describes the meaning of the permissions for Command and Event type of Targets:
# Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM.
# Write: Grants no capabilities; Commands are executed instead of written to and Events are read only.
# Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event.
# Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription.
Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown.
When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered "trusted".
If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller.
{{datatype|expand}}
Enable/Disable this {{object}} instance.
{{nolist}}
Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this {{object}} instance.
The roles are added to the Controller's current list of Roles by replacing the value of the {{param|###.LocalAgent.Controller.{i}.InheritedRole}} parameter.
If the Controller is already known to the Agent, with an associated Role, this parameter has no impact.
A reference to the {{object|##.Certificate.{i}}} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption.
Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize.
The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers.
The CA can authorize MTP (domain) connectivity and authenticate Controllers.
The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See {{bibref|TR-369|"Authentication and Authorization"}} for additional description of the Trusted Broker function.
Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate.
The Controller requests a type of challenge from an Agent using the RequestChallenge command.
The Agent returns the value of the {{param|Instruction}} for that type of challenge to the Controller which the Controller then provides a third-party.
The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command.
The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller.
This could include (but is not limited to):
*Assignment of roles to the Controller is done by appending the non-duplicate roles of the {{param|Role}} parameter to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter.
*Use the Controller's certificate to which the challenge response was received in order to authenticate the identity of the Controller.
{{datatype|expand}}
The description of this {{object}} instance.
{{nolist}}
Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter.
Enable/Disable this {{object}} instance.
The type of challenge that will be verified from the challenge response provided by the third-party through the Controller.
The challenge uses a passphrase the third-party is expected to match.
The value of the challenge that is specific to the type of challenge.
The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Value}} parameter.
The instruction that is provided to the external party by the Controller requesting the challenge.
The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter.
The number of times a challenge is retried before the challenge procedure is terminated.
The time, in {{units}} that a Controller that has failed the challenge is locked out (based on the value of the {{param|Retries}} parameter) prior to being provided the challenge again.
A value of zero means that a LockoutPeriod doesn't apply and the challenge can be provided indefinitely.
The {{object}} represents the STOMP capabilities of the device as described in {{bibref|TR-369}}.
{{numentries}}
The {{object}} represents a STOMP connection between the Agent and a STOMP server.
{{datatype|expand}}
Enables or disables this {{object}}.
This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}.
The current operational state of this {{object}} (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}}
When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Disabled}} or {{enum|Error}} if there is a fault condition on the interface).
When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD change to {{enum|Enabled}} if and only if the interface is able to transmit and receive PDUs; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason.
The date and time at which this {{object}} entered into its current operational state.
The hostname or IP Address of the STOMP Server.
The port number of the STOMP Server.
The username part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server.
The password part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server.
The Virtual Host to use when establishing the connection.
Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources.
Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}).
When the STOMP Heart-beat mechanism is enabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} determine how the heart-beat header within the CONNECT frame is formatted.
When the STOMP Heart-beat mechanism is disabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} are ignored and the CONNECT frame MUST NOT contain a heart-beat header element.
Any changes to this parameter will not take effect until the next connection.
Represents the Outgoing heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}).
The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats.
Any changes to this parameter will not take effect until the next connection.
Represents the Incoming heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}).
The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats.
Any changes to this parameter will not take effect until the next connection.
The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-369}}.
The Device MUST use a random value between ''0'' and {{param}} as the first reconnection wait interval.
The reconnection interval multiplier as specified in {{bibref|TR-369}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
For the ''n''th reconnection wait interval, the Device MUST use a random value, in ''seconds'', between ''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000) ** (''n'' - ''1'').
The maximum reconnection wait interval, in {{units}}.
If the ''n''th reconnection wait interval calculated from {{param|ServerRetryInitialInterval}} and {{param|ServerRetryIntervalMultiplier}} exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval.
This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted.
Capabilities of a Device as it pertains to entering a standby state.
Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state.
Indicates that the device is capable of maintaining and responding to timers while in a standby state.
Top level object for dynamically managed software applications.
Install one or more Deployment Units (DUs) to the associated {{object}}.
The URL, as defined in {{bibref|RFC3986}}, that specifies the location of the DU to be installed.
The URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported.
The UUID (see {{bibref|RFC4122}}) of the DU to be installed.
If this parameter is {{empty}} the device MUST generate the UUID based on the rules defined in {{bibref|RFC4122}} and {{bibref|TR-069|Annex H}}.
Username to be used by the device to authenticate with the file server, if authentication is required.
Password to be used by the device to authenticate with the file server, if authentication is required.
A reference to the Execution Environment upon which the DU to be installed.
If {{empty}} the device MUST choose the Execution Environment to use.
This event informs a Controller of the completion (successful or unsuccessful) of a DU state change.
When used, this event MUST be issued after the device has completed any file transfers and carried out all operations related to the DU State Change.
This event MAY contain the results from multiple DU state changes; it is implementation specific how the device chooses to aggregate the DU state changes, although the device MUST notify the Controller of any DU state changes within 24 hours of the time the operations were completed by the device.
The device SHOULD make every attempt to aggregate, as much as possible, the DU State Change notifications to the Controller in the interest of scalability.
The UUID as defined in {{bibref|RFC4122}} of the DU that affected by the state change.
A reference to the DU that was affected by the state change.
In the case of an Install, this will be the version of the DU created. In the case of an Update, it will be the updated version of the DU. In the case of an Uninstall, it will be the version of the uninstalled DU.
This MUST match the {{param|.SoftwareModules.DeploymentUnit.{i}.Version}} Parameter contained within the instance of the DeploymentUnit that is contained within the {{param|DeploymentUnitRef}} argument.
The current state of the created DU.
The DU is in an Installed state due to one of the following: successful Install, successful Update, failed Update, or failed Uninstall. In the case of a failed Update or failed Uninstall the Fault argument will contain an explanation of the failure.
The DU was successfully uninstalled from the device.
The DU could not be installed in which case a DU instance MUST NOT be created in the Data Model.
Whether or not the DU operation resolved all of its dependencies.
In the case of a successful Uninstall, this value is meaningless and should be {{true}}.
The Execution Units affected by this operation.
In the case of an Install, this will be the list of EUs that were created as a result of the DU’s installation.
In the case an Update, this will be the list of all EUs currently associated with the updated DU, including those that were created through the initial DU installation and any updates that had already occurred but not including any EUs that no longer exist on the device because of this or previous updates.
In the case of an Uninstall, this will be the list of the EUs removed from the device due to the DU being removed.
The date and time transfer was started in UTC. The device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value.
The date and time the transfer was fully completed and applied in UTC. This need only be filled in if the transfer has been fully completed and applied. The device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value.
The operation that was performed against the DU causing the DU state change.
The operation attempted was the Installation of a DU.
The operation attempted was the Update of an existing DU.
The operation attempted was the Un-Installation of an existing DU.
Fault Structure. If the operation was successful, the {{param|FaultCode}} MUST be zero. Otherwise a non-zero {{param|FaultCode}} is specified along with a {{param|FaultString}} indicating the failure reason.
The numerical fault code. Valid values are:
*If the operation was successful, the fault code is 0.
*If the device cannot complete the operation for some unknown reason, it SHOULD reject the operation with a 9001 (Request Denied) fault code.
*If the device detects the presence of the "userinfo" component in the file source URL, it SHOULD reject the operation with a 9003 (Invalid Arguments) fault code.
*If the device cannot find the Execution Environment specified in the Install or Update command, it SHOULD reject the operation with a 9023 (Unknown Execution Environment) fault code.
*If the device determines that the Deployment Unit being installed does not match either the Execution Environment specified or any Execution Environment on the device, it SHOULD reject the operation with a 9025 (Deployment Unit to Execution Environment Mismatch) fault code
*If the device detects that the Deployment Unit being installed already has the same version as one already installed on the same Execution Environment, it SHOULD reject the operation with a 9026 (Duplicate Deployment Unit) fault code.
*If the device detects that that there are no more system resources (disk space, memory, etc.) to perform the Install or Update of a Deployment Unit, it SHOULD reject the operation with a 9027 (System Resources Exceeded) fault code.
*If a requested operation attempts to alter the State of a Deployment Unit in a manner that conflicts with the Deployment Unit State Machine Diagram {{bibref|TR-369|Appendix I "Software Module Management"}}, it SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
*If a requested operation attempts to Uninstall a DU that caused an EE to come into existence, where that EE has at least 1 installed DU or at least 1 child EE, then the device SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
A human-readable text description of the fault. This field SHOULD be empty if the FaultCode equals 0 (zero).
{{numentries}}
{{numentries}}
{{numentries}}
The Execution Environments that are available on the device, along with their properties and configurable settings.
Indicates whether or not this {{object}} is enabled.
Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it.
When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to {{enum|Idle|#.ExecutionUnit.{i}.Status}}.
If an Update or Uninstall operation is attempted on a {{object|#.DeploymentUnit}} that is to be applied against a disabled {{object}}, that operation fails and the associated event will contain a FaultStruct for that operation.
Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an {{object}} and a Controller disabled it, the Agent might be terminated leaving the device unmanageable.
Indicates the status of this {{object}}.
{{datatype|expand}}
A Name provided by the device that adequately distinguishes this {{object}} from all other {{object}} instances.
Indicates the complete type and specification version of this {{object}}.
The run level that this {{object}} will be in upon startup (whether that is caused by a device Boot or the Execution Environment starting).
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
If the value of {{param|CurrentRunLevel}} is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this {{object}}.
The run level that this {{object}} is currently operating in. This value is altered by executing the {{command|SetRunLevel()}} command.
Upon startup (whether that is caused by a device Boot or the Execution Environment starting) {{param}} will be equal to {{param|InitialRunLevel}}, unless Run Levels are not supported by this {{object}} in which case {{param}} will be -1.
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
If {{param}} is -1 then Run Levels are not supported by this {{object}} and setting {{param|InitialRunLevel}} or executing the command {{command|SetRunLevel()}} will not impact the Run Level of this {{object}}.
Indicates the initial value on creation for {{param|#.ExecutionUnit.{i}.RunLevel}} for all Execution Unit instances associated with this {{object}}.
If the value of {{param|CurrentRunLevel}} is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit.
The vendor that produced this {{object}}.
The Version of this {{object}} as specified by the Vendor that implemented this {{object}}, not the version of the specification.
Represents the parent {{object}} of this {{object}}.
If this value is {{empty}} then this is the Primary Execution Environment.
The amount of disk space measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of disk space measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} consumes disk space. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} are started/stopped and consume the physical RAM. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
Represents the {{object|#.ExecutionUnit}} instances currently running on this {{object}}. This parameter only contains {{object|#.ExecutionUnit}} instances that currently have a {{param|#.ExecutionUnit.{i}.Status}} of {{enum|Active|#.ExecutionUnit.{i}.Status}}.
Represents the processors that this {{object}} has available to it.
Provides a mechanism to remotely manipulate the run level of this {{object}}, meaning that altering this comand will change the value of the {{param|#.CurrentRunLevel}}.
Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}.
This parameter will request to change the value of the {{param|#.CurrentRunLevel}} to the value of this parameter.
Setting this value when {{param|#.CurrentRunLevel}} is -1 has no impact to the Run Level of this instance of the {{object|##.}} object.
This command causes this {{object}} to revert back to the state it was in when the device last issued a Boot event with a cause of a local or remote factory reset.
The following requirements dictate what MUST happen for the reset to be complete:
# All Deployment Units that were installed after the last Boot (with cause of a factory reset) event MUST be removed
# All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
# Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last Boot (with cause of a factory reset) event event was issued
# Any Deployment Unit that was present when the last Boot (with cause of a factory reset) eventevent was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last "0 BOOTSTRAP" Inform event was issued
# The Execution Environment MUST be restored to the version and configuration present when the last Boot (with cause of a factory reset) eventevent was issued
# The Execution Environment MUST be restarted after all other restoration requirements have been met
This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.
A new instance of this table gets created during the installation of a Software Module.
A Universally Unique Identifier either provided by the Controller, or generated by the device, at the time of Deployment Unit Installation.
The format of this value is defined by {{bibref|RFC4122}} Version 5 (Name-Based) and {{bibref|TR-181i2a12|Appendix TBD}}.
This value MUST NOT be altered when the {{object}} is updated.
Deployment Unit Identifier chosen by the targeted {{object|#.ExecEnv}}. The format of this value is Execution Environment specific.
{{datatype|expand}}
Indicates the Name of this {{object}}, which is chosen by the author of the Deployment Unit.
The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069|Annex H}}.
Indicates the status of this {{object}}.
This instance is in the process of being Installed and SHOULD transition to the {{enum|Installed}} state.
This instance has been successfully Installed. The {{param|Resolved}} flag SHOULD also be referenced for dependency resolution.
This instance is in the process of being Updated and SHOULD transition to the {{enum|Installed}} state.
This instance is in the process of being Uninstalled and SHOULD transition to the {{enum|Uninstalled}} state.
This instance has been successfully Uninstalled. This status will typically not be seen within a {{object}} instance.
Indicates whether or not this {{object}} has resolved all of its dependencies.
Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this {{object}}.
Textual description of this {{object}}. The format of this value is Execution Environment specific.
The author of this {{object}} formatted as a domain name.
The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069a3|Annex H}}.
Version of this {{object}}. The format of this value is Execution Environment specific.
Represents the vendor log files that have come into existence because of this {{object}}.
This does not include any vendor log files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}.
When this {{object}} is uninstalled the vendor log files referenced here SHOULD be removed from the device.
Not all {{object}} instances will actually have a corresponding vendor log file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence because of this {{object}}.
This does not include any vendor config files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}.
When this {{object}} is uninstalled the vendor config files referenced here SHOULD be removed from the device.
Not all {{object}} instances will actually have a corresponding vendor config file, in which case the value of this parameter will be {{empty}}.
Represents the {{object|#.ExecutionUnit}} instances that are associated with this {{object}} instance.
Represents the {{object|#.ExecEnv}} instance where this {{object}} instance is installed.
Update the associated {{object}}.
The URL, as defined in {{bibref|RFC3986}}, that specifies the location of the DU to be installed.
The URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported.
If the device receives an Update command with the same source URL as a previous Update or Install comamnd, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.
Username to be used by the device to authenticate with the file server, if authentication is required.
Password to be used by the device to authenticate with the file server, if authentication is required.
Uninstall the associated {{object}}.
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.
Each {{object|#.DeploymentUnit}} that is installed can have zero or more Execution Units.
Once a Deployment Unit is installed it populates this table with its contained Execution Units.
When the Deployment Unit (that caused this {{object}} to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this {{object}} to come into existence) is being updated, all {{object}} instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.
When the Deployment Unit (that caused this {{object}} to come into existence) is uninstalled, this instance is removed.
Each {{object}} MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the {{object|Extensions}} object.
Execution Unit Identifier chosen by the {{object|#.ExecEnv}} during installation of the associated {{object|#.DeploymentUnit}}.
The format of this value is Execution Environment specific, but it MUST be unique across {{object|#.ExecEnv}} instances. Thus, it is recommended that this be a combination of the {{param|#.ExecEnv.{i}.Name}} and an Execution Environment local unique value.
{{datatype|expand}}
The name of this {{object}} as it pertains to its associated {{object|#.DeploymentUnit}}, which SHOULD be unique across all {{object}} instances contained within its associated {{object|#.DeploymentUnit}}.
The name of this {{object}} as provided by the {{object|#.ExecEnv}}, which SHOULD be unique across all {{object}} instances contained within a specific {{object|#.ExecEnv}}.
Indicates the status of this {{object}}.
This instance is in an Idle state and not running.
This instance is in the process of Starting and SHOULD transition to the {{enum|Active}} state.
This instance is currently running.
This instance is in the process of Stopping and SHOULD transition to the {{enum|Idle}} state.
If while running or transitioning between states this {{object}} identifies a fault this parameter embodies the problem. The value of {{enum|NoFault}} MUST be used when everything is working as intended. {{enum}}
For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}.
If while running or transitioning between states this {{object}} identifies a fault this parameter provides a more detailed explanation of the problem.
If {{param|ExecutionFaultCode}} has the value of {{enum|NoFault|ExecutionFaultCode}} then the value of this parameter MUST {{empty}} and ignored by the Controller.
If {{true}} and the {{param|RunLevel}} verification is also met, then this {{object}} will be automatically started by the device after its {{object|#.ExecEnv}} is either rebooted or restarted.
If {{false}} this {{object}} will not be started after its {{object|#.ExecEnv}} is either rebooted or restarted until it is explicitly commanded to do so by either the Controller or another Execution Unit.
Determines when this {{object}} will be started.
If {{param|AutoStart}} is {{true}} and {{param|#.ExecEnv.{i}.CurrentRunLevel}} is greater than or equal to {{param}}, then this {{object}} will be started.
If the value of {{param|#.ExecEnv.{i}.CurrentRunLevel}} is -1, then the associated {{object|#.ExecEnv.}} doesn't support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this {{object}}.
Vendor of this {{object}}.
Version of the {{object}}. The format of this value is Execution Environment specific.
Textual description of this {{object}}. The format of this value is Execution Environment specific.
The amount of disk space measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
The amount of physical RAM measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable.
Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}.
NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this {{object}} has caused to come into existence can be discovered via the GetSupportedDM and GetInstances USP messages.
Represents the system processes that are active in the system because of this {{object}}.
If {{param|Status}} is not {{enum|Active|Status}} it is expected that this list will be {{empty}}. Some {{object}} instances MIGHT NOT have any system processes irrespective of the value of {{param|Status}}.
Represents the vendor log files that have come into existence because of this {{object}}.
When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the device.
Not all {{object}} instances will actually have a corresponding vendor log file, in which case the value of this parameter will be {{empty}}.
Represents the vendor config files that have come into existence because of this {{object}}.
When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the device.
Not all {{object}} instances will actually have a corresponding vendor config file, in which case the value of this parameter will be {{empty}}.
Represents the {{object|#.ExecEnv}} that this {{object}} is associated with.
Set the state transition that the Controller is requesting for this instance of the {{object}} object. {{enum}}
If this instance of the {{object}} object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated.
Indicates the requested state to transition this instance of the {{object|##.}} object. {{enum}}
If this {{object|##.}} is currently in {{enum|Starting|###.ExecutionUnit.{i}.Status}} or {{enum|Active|###.ExecutionUnit.{i}.Status}} the device will attempt to Stop the Execution Unit; otherwise this requested state is ignored.
If this {{object|##.}} is currently in {{enum|Idle|###.ExecutionUnit.{i}.Status}} the device will attempt to Start the Execution Unit.
If this {{object|##.}} is in {{enum|Stopping|###.ExecutionUnit.{i}.Status}} the request is rejected and a fault raised. Otherwise this requested state is ignored.
This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit.
It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of {{param|#.References}} and use of GetSupportDM and GetInstances USP messages will be used to determine their locations.
Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running.
{{datatype|expand}}
{{reference|the {{object|Device.LocalAgent.Controller.}} instance that created or last updated this {{object}}}}
The value of this parameter is automatically populated by the USP Agent upon {{object}} creation using the reference to the USP Controller that created the instance.
The value of this parameter is automatically updated by the USP Agent upon {{object}} alteration using the reference to the USP Controller that changed the instance.
This command is issued to download a firmware into this Firmware Image instance.
All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.
URL, as defined in {{bibref|RFC3986}}, specifying the source file location. HTTP and HTTPS transports MUST be supported.
If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.
This URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
If {{true}} the Agent MUST automatically activate the firmware once it is successfully downloaded.
If {{false}} the Agent MUST NOT activate the firmware until explicitly instructed to do so by either invoking {{command|#.Activate()}} or setting {{param|##.BootFirmwareImage}} and rebooting the Agent.
Username to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required.
Password to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required.
The size of the file to be downloaded in bytes.
The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file.
The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise.
The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space.
If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate.
The hash algorithm to use when performing a checksum validation of the downloaded file.
If the {{param|CheckSum}} input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the {{param|CheckSum}} input argument against a hash of the downloaded file.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
The hash value of the downloaded file used to validate the integrity of the downloaded file.
If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the {{param|CheckSumAlgorithm}} input argument.
If this argument is {{empty}}, the Agent MUST NOT perform a checksum validation of the downloaded file.
This command is issued to activate this {{object}} instance.
A {{object}} instance can also be activated by setting the {{param|Device.DeviceInfo.BootFirmwareImage}} parameter and causing the Agent to reboot.
A successful activation will result in a reboot of the device with this {{object}} as the currently running firmware image. Furthermore, this {{object}} will be referenced by the {{param|Device.DeviceInfo.ActiveFirmwareImage}} parameter.
A failed activation will result in this {{object}} instance's {{param|BootFailureLog}} being updated.
The time window(s) that dictate when the Agent activates the firmware image.
An Agent MUST be able to accept a request with either one or two {{object}} instances.
The time windows MUST NOT overlap, i.e. if there are two time windows, the second window’s Start value has to be greater than or equal to the first window’s End value.
Start of this time window as an offset in {{units}} after invoking the command. An offset is used in order to avoid a dependence on absolute time.
End of this time window as an offset in {{units}} after invoking the command. An offset is used in order to avoid a dependence on absolute time.
Specifies when within this time window the Agent is permitted to activate the specified firmware image.
The Agent MAY activate the firmware image at any time during the time window even if this results in interruption of service for the subscriber.
The Agent MUST activate the firmware image immediately at the start of the time window even if this results in interruption of service for the subscriber.
The Agent MUST NOT cause an interruption of service from the subscriber's standpoint while activating the firmware image during the time window.
How the Agent determines this is outside the scope of this specification.
The Agent MUST ask for and receive confirmation before activating the firmware image.
It is outside the scope of this specification how the Agent asks for and receives this confirmation.
If confirmation is not received, this time window MUST NOT be used.
A message that informs the user of a request to activate a new firmware image.
The Agent MAY use this message when seeking confirmation from the user, e.g. when {{param|Mode}} is {{enum|ConfirmationNeeded|Mode}}.
When there is no need for such a message, it SHOULD be {{empty}} and MUST be ignored.
The maximum number of retries for activating the firmware image before regarding the transfer as having failed. Refers only to this time window (each time window can specify its own value).
A value of 0 means “No retries are permitted”. A value of -1 means “the Agent determines the number of retries”, i.e. that the Agent can use its own retry policy, not that it has to retry forever.
Only applicable when the {{param|Mode}} input argument is {{enum|ConfirmationNeeded|Mode}}, otherwise this input argument MUST be ignored.
This command is issued to upload the log file specified by this Vendor Log File instance.
All results of the actual upload will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.
URL, as defined in {{bibref|RFC3986}}, specifying the destination file location. HTTP and HTTPS transports MUST be supported.
This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.
If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time.
This URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
Password to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
This command is issued to upload the configuration file specified by this {{object}} instance.
All results of the actual upload will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.
URL, as defined in {{bibref|RFC3986}}, specifying the destination file location. HTTP and HTTPS transports MUST be supported.
This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.
If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time.
This URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
Password to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
This command is issued to download a configuration file into this {{object}} instance.
All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event.
URL, as defined in {{bibref|RFC3986}}, specifying the source file location. HTTP and HTTPS transports MUST be supported.
If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.
This URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}.
Username to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
Password to be used by the Agent to authenticate with the file server. This string is set to {{empty}} if no authentication is required.
The size of the file to be downloaded in bytes.
The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file.
The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise.
The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space.
If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate.
The name of the file to be used on the target file system. This argument MAY be {{empty}} if the target file name can be extracted from the downloaded file itself, or from the URL argument, or if no target file name is needed.
If this argument is specified, but the target file name is also indicated by another source (for example, if it is extracted from the downloaded file itself), this argument MUST be ignored.
If the target file name is used, the downloaded file would replace any existing file of the same name (whether or not the Agent archives the replaced file is a local matter).
If present, this Parameter is treated as an opaque string with no specific requirements for its format. That is, the TargetFileName value is to be interpreted based on the Agent's vendor-specific file naming conventions.
Note that this specification does not preclude the use of a file naming convention in which the file’s path can be specified as part of the file name.
The hash algorithm to use when performing a checksum validation of the downloaded file.
If the {{param|CheckSum}} input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the {{param|CheckSum}} input argument against a hash of the downloaded file.
As specified in {{bibref|RFC3174}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
As specified in {{bibref|RFC6234}}.
The hash value of the downloaded file used to validate the integrity of the downloaded file.
If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the {{param|CheckSumAlgorithm}} input argument.
If this argument is {{empty}}, the Agent MUST NOT perform a checksum validation of the downloaded file.
This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL.
Asynchronous Transfer Mode (ATM) object that contains the {{object|Link}} interface and {{object|Diagnostics.F5Loopback()}} diagnostics.
This command provides access to an ATM-layer F5 OAM loopback test.
HPNA PHY throughput diagnostics configuration and results.
When diagnostics are requested, all HPNA nodes for which the {{param|#.Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
HPNA performance monitoring configuration and results.
Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network.
G.hn PHY throughput diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PHYThroughputDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
G.hn Performance Monitoring diagnostics configuration and results.
When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PerformanceMonitoringDiagnosticsEnable}} parameter is set enter PHY diagnostics mode.
This command provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The {{param|Type}} parameter is used to select which type of test to perform.
CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network).
This command defines access to other WiFi SSIDs that this device is able to receive.
This parameter represents a request to reset or reboot the WiFi sub-system without resetting or rebooting the device.
This command provides access to an IP-layer ping test.
Indicates which IP address was used to send the Ping request.
This command defines access to an IP-layer trace-route test for the specified IP interface.
Indicates which IP address was used for TraceRoute.
The maximum number of rows in {{object|DownloadDiagnostics().IncrementalResult}} that the CPE will store.
This command defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.
Files received in the DownloadDiagnostics do not require file storage on the CPE device.
The number of connections to be used in the test. The default value SHOULD be 1. {{param}} MUST NOT be set to a value greater than {{param|#.DownloadDiagnosticMaxConnections}}.
Results for individual connections. This table is only populated when {{param|#.EnablePerConnectionResults}} is {{true}}. A new object is created for each connection specified in {{param|#.NumberOfConnections}}. Instance numbers MUST start at 1 and sequentially increment as new instances are created.
Results for time segmented tests (tests where {{param|#.TimeBasedTestDuration}} > 0 and {{param|#.TimeBasedTestMeasurementInterval}} > 0). This data is totaled across all connections in the test. A new object is created every {{param|#.TimeBasedTestMeasurementInterval}} after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created.
The maximum number of rows in {{object|UploadDiagnostics().IncrementalResult}} that the CPE will store.
This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.
Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.
The number of connections to be used in the test. The default value SHOULD be 1. {{param}} MUST NOT be set to a value greater than {{param|#.UploadDiagnosticsMaxConnections}}.
Results for individual connections. This table is only populated when {{param|#.EnablePerConnectionResults}} is {{true}}. A new object is created for each connection specified in {{param|#.NumberOfConnections}}. Instance numbers MUST start at 1 and sequentially increment as new instances are created.
Results for time segmented tests (tests where {{param|#.TimeBasedTestDuration}} > 0 and {{param|#.TimeBasedTestMeasurementInterval}} > 0). This data is totaled across all connections in the test. A new object is created every {{param|#.TimeBasedTestMeasurementInterval}} after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created.
The maximum number of rows in {{object|UDPEchoDiagnostics().IndividualPacketResult}} that the CPE will store. If a test would create more rows than {{param}} only the first {{param}} rows are present in {{object|UDPEchoDiagnostics().IndividualPacketResult}}.
This command defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143a1|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143a1|Appendix A.1}}.
This object provides the results from individual UDPEchoPlus test packets collected during a test if {{param|#.EnableIndividualPacketResults}} is set to true. It should contain {{param|#.NumberOfRepetitions}} objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet.
This command provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out.
The DNS Diagnostics object containing the {{object|NSLookupDiagnostics()}} test.
This command defines access to an IP-layer NS Lookup test for the specified IP interface.
When initiated, the NS Lookup test will contact {{param|DNSServer}} and look up {{param|HostName}} {{param|NumberOfRepetitions}} times.
There will be a {{object|Result}} instance for each time the device performs a DNS lookup, which is determined by the value of {{param|NumberOfRepetitions}}.
Any previous {{object|Result}} instances are removed when a new test is initiated.
Result Parameter to represent whether the NS Lookup was successful or not.
Reset this {{object|#}} instance's WiFi security settings to their factory default values. The affected settings include {{param|ModeEnabled}}, {{param|WEPKey}}, {{param|PreSharedKey}} , {{param|KeyPassphrase}} and {{param|#.WPS.PIN}} (if applicable).
If the command cannot be executed, the agent MUST reject the command. Possible failure reasons include a lack of default values or if {{param|ModeEnabled}} is an Enterprise type, i.e. {{enum|WPA-Enterprise|ModesSupported}}, {{enum|WPA2-Enterprise|ModesSupported}} or {{enum|WPA-WPA2-Enterprise|ModesSupported}}.
The {{object}} will renew its DHCPv6-supplied information (i.e. the Agent will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance).
Reset the GPS Hardware.
Resets the temperature sensor.
Present only if the Agent provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.
Reset {{param|.LANConfigSecurity.ConfigPassword}} to its factory value.
Reset the Host Controller and apply the reset signaling (see {{bibref|USB2.0|Chapter 7.1.7.5}}) to all of the Host Controller Hub downstream ports.
On a reset the device MUST tear down the existing PPP connection represented by this object and establish a new one.
The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.
Reset on a disabled interface is a no-op (not an error).
On a reset device MUST tear down the existing IP connection represented by this object and establish a new one.
The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call.
Reset on a disabled interface is a no-op (not an error).
The DHCP client will renew its DHCP lease.
On a reset the device MUST reset the session by performing an initial authentication attempt as defined in {{bibref|802.1x-2004|9.6.1.3}}, Initialize Port by sending out the EAP start message.
The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call.
On a reset the device MUST disconnect (forced unauthentication) the resource.
The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call.
Reset the SmartCard Reader and the associated SmartCard.
Force statistics for the current sample to be calculated and updated in the data model.
If this is the first time that this command is called during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters MUST be updated accordingly.
If this is not the first time that this command is during the current sample interval, then the new values that were added as described in the previous paragraph, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, MUST be updated accordingly.
Note that {{param}} just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.
At the end of each sample interval, if this command was executed during the sample interval then the new values that were added as described above, and the {{param|ReportEndTime}} and all {{param|SampleSeconds}} parameters, will be updated accordingly. In other words, the partial sample data that was created when the command was executed will be updated one last time at the end of the sample interval.
Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT client is in a different state, the command has no effect.
This command may be used to immediately apply changes in the MQTT connection settings.
Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT bridge is in a different state, the command has no effect.
This command may be used to immediately apply changes in the MQTT connection settings.
Note: This profile is valid for G.992.1 modems.
Note: This profile is valid for G.992.3 and G.992.5 modems.
Note: This profile is valid for G.993.2 modems.
This profile is IPv4 specific.
REQUIRED only for IPv6 capable devices.
REQUIRED only for IPv6 capable devices.
This table is REQUIRED to support sending of option 60 (Vendor Class Identifier) and option 77 (User Class Identifier) values.
This table is REQUIRED to support requesting of option 60 (Vendor Class Identifier), option 61 (Client Identifier) and option 77 (User Class Identifier) values.
Adds client authentication, will handling and extends statistics