{{template|MQTTChange}} If the change needs to be applied immediately, the
command {{command|ForceReconnect()}} has to be executed.
{{template|MQTTChange}}
If will handling is enabled (Parameter {{param|WillEnable}} is set to
{{true}}) and the change needs to be applied immediately, the command
{{command|ForceReconnect()}} has to be executed.
{{command|Reset()}} command is invoked
{{bibref|TR-369|Annex A}}
{{bibref|TR-369|Annex A.1.1}}
{{bibref|TR-369|Annex A.1.2.1}}
{{bibref|TR-369|Annex A.2.1}}
{{bibref|TR-369|Annex A.2.4}}
{{bibref|TR-369|Annex A.2.5}}
The USPEventNotif solution is based on sending a
{{event|Profile.{i}.Push!}} Event Notification via USP {{bibref|TR-369}}.
This value is retained across reboots and is only reset after another scan
completes successfully or {{command|GPSReset()}} is invoked.
{{command|Device.PeriodicStatistics.SampleSet.{i}.ForceSample()}}
{{param|Device.PeriodicStatistics.SampleSet.{i}.Push!.Parameter.{i}.Failures}}
{{command|#.RequestChallenge()}}
{{command|#.ChallengeResponse()}}
Whenever the Agent successfully restores a configuration file as a result
of the {{command|Restore()}} Command, the Agent MUST update this Object.
Otherwise, the value of this parameter MUST be set to the value of the
Command input argument {{param|Restore().Input.TargetFileName}} used to
restore this configuration file.
{{command|Device.IP.Diagnostics.IPLayerCapacity()}}
{{numentries}}
Reboot the entity associated with the containing {{object}}.
The cause that will be contained within the {{event|#.Boot!}} Event.
By default the Device SHOULD set this value to {{enum|RemoteReboot}}.
A {{object|Device.|absolute}} Event that was the result of a reboot triggered
locally on the Device (NOT as a result of a
{{command|.Reboot()|model}}}} Command triggered by a remote trigger, e.g.
another remote management protocol)
A {{object|Device.|absolute}} Event that was the result of a reboot triggered
via the {{command|.Reboot()|model}}} Command or other remote
trigger, e.g. another remote management protocol
The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, ...).
When absent the implementation must set {{param}} to 'Unknown'.
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 reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, ...).
{{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}}.
The cause that will be contained within the {{event|#.Boot!}} Event.
By default the Device SHOULD set this value to {{enum|RemoteFactoryReset}}.
A {{object|Device.|absolute}} Event that was the result of a factory reset
triggered locally on the Device (NOT as a result of a
{{command|.FactoryReset()|model}}} Command trigger by a remote trigger,
e.g. another remote management protocol)
A {{object|Device.|absolute}} Event that was the result of a factory reset
triggered via the {{command|.FactoryReset()|model}} Command or
other remote trigger, e.g. another remote management protocol
The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, ...).
When absent the implementation must set {{param}} to 'Unknown'.
This diagnostics test is vendor-specific and MAY include testing
hardware, software, and/or firmware.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
This diagnostic command is used to record packet capture data on a
valid (layer 2 or above) interface in libpcap or pcapng format.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
Schedule an async timer operation. A scheduled timer MUST persist
across reboots.
NOTE: This command changed from synchronous to asynchronous in
version 2.14.
The number of {{units}} from the time this command is invoked
until the Agent responds with an OperationComplete Event
notification (based on the associated subscriptions).
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-assigned 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.
The maximum number of time windows in a
{{command|FirmwareImage.{i}.Activate()}} Command that the Device
supports.
IPDR Streaming Protocol {{bibref|IPDR-SP}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
User Services Platform (USP - {{bibref|TR-369|Annex A}}) Event
Notification
Used with the IPDR Streaming and File Protocols.
{{bibref|IPDR-XML}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
Used with the IPDR Streaming and File Protocols.
{{bibref|IPDR-XDR}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
Comma Separated Values. Used with the HTTP and USPEventNotif
Protocols. {{bibref|RFC4180}}
JavaScript Object Notation. Used with the HTTP and
USPEventNotif Protocols. {{bibref|RFC7159}}
{{reference|the {{object|##.LocalAgent.Controller}} instance that
created {{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.
The USP Controller referenced by this parameter also defines the set
of permissions to use when generating the Bulk Data report.
Furthermore, only the USP Controller referenced by this parameter
will receive a {{event|Push!}} Event (assuming it has an associated
Subscription) when the Profile has {{param|Protocol}} configured to
{{enum|USPEventNotif|Protocol}}, even if another USP Controller has
an associated Subscription.
This is the host name or IP Address of the IPDR Collector to be used
by the CPE to stream bulk data records if this collection profile is
configured for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
This is the port number of the IPDR Collector to be used by the CPE
to stream bulk data records if this collection profile is configured
for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the
{{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
This is the unique identification of an IPDR Session to be used when
this collection profile is configured for the IPDR Streaming Protocol
{{bibref|IPDR-SP}} (the {{param|Protocol}} parameter has a value of
{{enum|Streaming|#.Protocols}}).
A Controller MUST NOT configure multiple IPDR Streaming Protocol
collection profiles with the same {{param}}. Doing so MUST cause the
CPE to fail the SetParameterValues.
Within the IPDR Streaming Protocol specification the Session ID has a
type of a single 'char', but we are restricting the range even
further (ASCII values of '0' - '9' and 'A' - 'Z').
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
This is the {{datatype}} within the CPE that is used by an IPDR
Collector to retrieve the IPDRDocs when this collection profile is
configured for the IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
(the {{param|Protocol}} parameter has a value of
{{enum|File|#.Protocols}}).
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
Username used for authentication of the {{param|FileTransferURL}}.
This is the {{param}} that the IPDR Collector uses to access the CPE
when this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}).
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
Password used for authentication of the {{param|FileTransferURL}}.
This is the {{param}} that the IPDR Collector uses to access the CPE
when this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}).
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
If this collection profile is configured for the IPDR File Transfer
Protocol {{bibref|IPDR-FTP}} (the {{param|Protocol}} parameter has a
value of {{enum|File|#.Protocols}}) then the control file names will
be of the following format:
:
<ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix>
Where the following rules apply:
* ControlFilePrefix MUST NOT contain an underscore '_' or any other
character not suitable for a file name.
* ControlFilePolicy MUST contain one or more 'N' characters, where
the number of 'N' characters denotes the number of digits in the
sequence number, including leading zeros as necessary to match the
number of 'N' characters.
* ControlFileSuffix is a file extension.
For example, BulkData_NNNN.log where "BulkData" would be the prefix,
"NNNN" would be the policy, and "log" would be the suffix. Files
adhering to this file format would look like: BulkData_0000.log,
BulkData_0001.log, etc.
{{deprecated|2.15|because IPDR Bulk Data Collection is not supported
in USP}}
{{obsoleted|2.17}}
{{deleted|2.18}}
Bulk Data Push event for delivering a bulk data report within a USP
Notification message.
The contents of the bulk data report in the configured CSV or JSON
Encoding Type.
Start the bulk data collection and transmission as defined in this
profile immediately, regardless of the current values of the
{{param|Enable}} and {{param|ReportingInterval}} parameters.
This command can be used for testing of the bulk data collection
mechanism and profile but also to preempt any regular schedule
without affecting it.
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.
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 {{datatype}} 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).
The hash algorithm that was used to generate the checksum
for the transferred 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}}.
There was no algorithm specified for the transferred file.
The hash value that was used for the transferred file. This hash value was
generated using transferred file content and the {{param|CheckSumAlgorithm}}.
If the argument is {{empty}}, not present, or the {{param|CheckSumAlgorithm}}
is {{enum|Unknown|CheckSumAlgorithm}}, then the
Controller can assume that the checksum is not applicable or
was not generated for this transfer.
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 command will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM)
{{bibref|RFC7468}} format.
{{list|each entry is a threshold operation for
{{param|Threshold.{i}.ThresholdOperator}} supported by the Agent}}
Parameter value changes from below the
{{param|Threshold.{i}.ThresholdValue}} to a value above
Parameter value changes from above the
{{param|Threshold.{i}.ThresholdValue}} to a value below
Parameter value either changes from above the
{{param|Threshold.{i}.ThresholdValue}} to a value below or vice
versa
Parameter value changes from any value to the
{{param|Threshold.{i}.ThresholdValue}}
Parameter value changes from the
{{param|Threshold.{i}.ThresholdValue}} to any other value
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
{{numentries}}
An indication of the maximum number of {{object|Subscription}}
instances supported by this implementation or -1 if no hard limit
exists.
Each {{object}} instance of this table represents a Threshold Event.
{{param|ThresholdParam}} is monitored to determine if it has met the
{{param|ThresholdOperator}} condition against {{param|ThresholdValue}},
when it meets the condition a {{event|Triggered!}} Event is sent.
{{param|ThresholdParam}} may only reference integer parameters and
{{param|ThresholdValue}} only uses integer values. For example:
{{param|ReferencePath}}: Device.Ethernet.Interface.[Enable=="1"].Stats.
{{param|ThresholdParam}}: BytesSent
{{param|ThresholdOperator}}: Rise
{{param|ThresholdValue}}: 100000
This would trigger a {{event|Triggered!}} Event whenever a value of a
parameter matching
Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below
to above 100000.
When creating a {{object}}, if the {{param|ReferencePath}},
{{param|ThresholdParam}} or {{param|ThresholdValue}} are invalid (not
in the supported Data Model), the object will not be created.
If the concatenation of {{param|ReferencePath}} and
{{param|ThresholdParam}} reference a parameter that isn't in the
instantiated data model, then there will be no {{event|Triggered!}}
Event.
Enable/Disable this {{object}} instance.
If the {{object}} instance is disabled, the {{event|Triggered!}}
Event will not be invoked, even if there is a
{{object|#.Subscription}} instance that references it.
Determines whether to disable this {{object}} instance after the
{{event|Triggered!}} Event has been invoked.
The {{object}} will execute the action as long as the
{{param|Enable}} parameter is {{true}}.
After invoking the {{event|Triggered!}} Event, the
{{param|Enable}} parameter will be automatically set to
{{false}}.
The concatenation of {{param}} and {{param|ThresholdParam}} refers to
the parameter being checked for the threshold test.
{{param}} can be either an Object Path, Object Instance Path, or and
Object Instance Path with a Search Expression instead of an Instance
Identifier, as defined in the introduction section of
{{bibref|TR-369}}.
The concatenation of {{param|ReferencePath}} and {{param}} refers to
the parameter being checked for the threshold test.
{{param}} is the name of the Parameter in the context of
{{param|ReferencePath}}.
The operator used for the threshold test.
The Value used for the threshold test.
{{reference|the {{object|#.Controller}} instance that created
{{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.
The USP Controller referenced by this parameter also defines the set
of permissions to use when evaluating the threshold. Furthermore,
only the USP Controller referenced by this parameter will receive a
{{event|Triggered!}} Event (assuming it has an associated
Subscription), even if another USP Controller has an associated
Subscription.
Triggered event requested via a {{object}} object.
When the {{param|ThresholdParam}} that is in the
{{param|ReferencePath}} changes and the threshold test conditation
changes from {{false}} to {{true}}, then the Triggered Event will be
invoked. The {{event}} will only be eligible for retriggering if the
test condition is fulfilled again.
The parameter ({{param|#.ReferencePath}} and
{{param|#.ThresholdParam}}) for which the threshold has been
triggered.
The new ({{param|#.ReferencePath}} and {{param|#.ThresholdParam}})
Value.
Each {{object}} instance of this table represents a Watchdog Event.
A {{object}} instance is used to detect the lack of an expected update of a parameter value within a certain time window {{param|ReloadTimerValue}}. In case this timer expires, meaning {{param|RemainingTimerValue}} becomes 0,
a notification event {{event|Watchdog!}}, will be sent to the {{param|Controller}}. This is because timely parameter updates are required, e.g. for SLA or security reasons.
Enable/Disable this {{object}} instance.
If the {{object}} instance is disabled, the {{event|Watchdog!}} will not be invoked, even if there is a {{object|#.Subscription}} instance that references it. The {{param|RemainingTimerValue}} will be set to 0.
If the {{object}} instance is set to enabled, the {{param|RemainingTimerValue}} will be set to the value of {{param|ReloadTimerValue}}.
Watchdog timer reload value in {{units}}. Every time the {{param|Reference}} value is updated, this {{param}} is used to reload the {{param|RemainingTimerValue}}.
This value is decreased every {{units}}. When 0, the {{object}} timer expires, an {{event|Watchdog!}} event will be generated.
The operational status of the {{object}} instance.
When the value of {{param|RemainingTimerValue}} becomes 0, this {{param}} will become {{enum|Expired}} and a {{event|Watchdog!}} event will be triggered. {{object}} will not be restarted, meaning that the {{param|RemainingTimerValue}} will stay at 0 until the {{command|Reset()}} command is invoked.
The {{param|Enable}} is disabled.
The {{param|Enable}} is enabled. The {{object}} timer is running. This means that {{param|RemainingTimerValue}} is decreased every second.
The {{param|Enable}} is enabled. The {{object}} timer expired whereby {{param|RemainingTimerValue}} is set to 0.
The {{param}} consists of a Path Name or Search Path that determines the element(s) of the data model that the {{object}} is applicable to.
When more than one {{param}} is used, the Watchdog timer will only be stopped if all Parameters, referenced by {{param}} are updated. If one of the referenced Parameters is not updated, either with the same or different value,
an {{event|Watchdog!}} will be generated.
If all parameters, referenced by {{param}}, are updated, the {{param|RemainingTimerValue}} is set to the value of the {{param|ReloadTimerValue}}.
Provides an indication of the severity which will be included in the generated {{event|Watchdog!}} event when the {{object}} instance expires.
{{reference|the {{object|#.Controller}} instance that created
{{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.
The USP Controller referenced by this parameter also defines the set
of permissions to use when evaluating the Watchdog. Furthermore,
only the USP Controller referenced by this parameter will receive a
{{event|Watchdog!}} Event (assuming it has an associated
Subscription), even if another USP Controller has an associated
Subscription.
When the {{command}} is invoked, the {{param|RemainingTimerValue}} will be set to the {{param|ReloadTimerValue}} and the {{param|Status}} to either {{enum|Active|Status}} or {{enum|Inactive|Status}} depending on the value of the {{param|Enable}} parameter.
Watchdog event requested via a {{object}} object.
When the {{param|RemainingTimerValue}} becomes 0 because the value of the
{{param|Reference}} was not updated then the Watchdog Event will be
invoked.
The parameter {{param|#.Reference}} for which the Watchdog has been
triggered.
The {{param|#.ReloadTimerValue}} Value in {{units}}.
The {{param|#.SeverityIndication}} Value.
Each {{object}} instance of this table represents an OnChange Event.
This would trigger a {{event|OnChange!}} Event whenever a value of a
parameter(s) matching {{param|ReferenceList}} changed during the time
interval specified by {{param|Interval}}.
When creating a {{object}}, if the {{param|ReferenceList}} is invalid
(not in the supported Data Model), the object will not be created.
Enable/Disable this {{object}} instance.
If the {{object}} instance is disabled, the {{event|OnChange!}} Event
will not be invoked, even if there is a {{object|#.Subscription}}
instance that references it.
Monitor interval in {{units}}. Parameters changed during this time
window will be part of the {{event|OnChange!}} Event. When set to
''0'', the Agent will send the {{event|OnChange!}} Event immediately
when it notices a change in one or more of the subscribed parameters.
Each entry in the list is a Path Name or Search Path that determines
the element(s) of the data model that the {{object}} is applicable
to.
{{reference|the {{object|#.Controller}} instance that created
{{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.
The USP Controller referenced by this parameter also defines the set
of permissions to use when evaluating the to be monitored changes.
Furthermore, only the USP Controller referenced by this parameter
will receive a {{event|OnChange!}} Event (assuming it has an
associated Subscription), even if another USP Controller has an
associated Subscription.
OnChange event requested via a {{object}} object.
When the values of the parameters specified by
{{param|ReferenceList}} change within in the configured
{{param|#.Interval}}, the agent MUST send an OnChange event.
Each ChangeSet entry contains the changes for a monitored object.
If multiple monitored objects change within the
{{param|##.Interval}}, there will be multiple ChangeSet entries.
When a parameter of an already included object changes multiple
times within in the configured {{param|##.Interval}}. The parameter
must be included in the {{object}} instance, where the {{param|ObjectPath}} was previously used, and a
new {{object|Parameter.{i}}} instance MUST be created.
Object path of the changed parameters.
OnChange parameter(s) table for the report sent by this event. This
table contains entries for parameters whose values have been
changed during the configured {{param|###.Interval}}.
Name of the changed parameter.
New value of the parameter specified by {{param|Name}}.
Previous value of the parameter specified by {{param|Name}}.
The date and time when the parameter was changed in UTC, which
MUST be specified to microsecond precision. For example:
2008-04-09T15:01:05.123456Z
Schedule a ''Timer!'' event on the associated {{object}}.
{{deprecated|2.14|because it was replaced by a more flexible
asynchronous {{command|##.ScheduleTimer()}}}}
{{obsoleted|2.16}}
{{deleted|2.17}}
The number of {{units}} 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.
{{deprecated|2.14|because the associated {{command|ScheduleTimer()}}
was replaced by a more flexible asynchronous
{{command|##.ScheduleTimer()}}}}
{{obsoleted|2.16}}
{{deleted|2.17}}
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.
This command can only be used by the Controller to whom the object
belongs. If the Controller issuing the USP Operate message is a
different Controller, the message MUST be denied.
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 command will fail.
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM)
{{bibref|RFC7468}} format.
Requests the Agent to send an ''OnBoardRequest'' notification to this
Controller. This sets the value of {{param|OnBoardingComplete}}
to {{false}}.
{{numentries}}
Signifies whether the onboarding is completed for this
Controller.
When set to {{false}}, the Controller hasn't completed its onboarding
procedure and the agent MUST send it an OnBoardRequest USP
Notification when the Controller's {{param|Enable}} parameter is
{{true}}. This OnBoardRequest MUST be retried until the Controller
confirms it has received the request as required by
{{bibref|TR-369|R-NOT.5}} and {{bibref|TR-369|R-NOT.6}}.
The value of this parameter SHOULD be set to {{true}} by the Controller
when it is done with its onboarding procedure or it can be set by the
Agent itself when it knows the onboarding has been completed.
While the value of this parameter is {{false}} it will also restart the OnBoardRequest procedure according to
the {{param|OnBoardingRestartTime}} parameter.
This parameter is used to configure a linear retry mechanism for the
OnBoardRequest. It represents the time in {{units}} before the
OnBoardRequest is retried.
The OnBoardRequest notification is a USP notification that requires
a NotifyResponse message like any other notification that needs to be
retried. OnBoardRequest notifications must follow the default retry
mechanism as required by {{bibref|TR-369|R-NOT.6}} until the
Controller has confirmed the notification with a NotifyResponse
message. However, the onboarding procedure typically requires several
actions from the Controller before it can be considered as complete
and things can go wrong during this procedure. The value of this
parameter can be set to configure how long the Agent should wait
before it sends another OnBoardRequest. This timer kicks in as soon
as the Agent receives the NotifyResponse message for the previous
OnBoardRequest. The timer is cancelled when the
{{param|OnBoardingComplete}} parameter is set to {{true}}.
When the value of this parameter is set to 0, the OnBoardRequest is
not retried after the notification retry mechanism has
been completed.
If enabled, this command will either request to start or restart an
WebSocket session with the Controller.
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.
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.
{{deprecated|2.15|because it is replaced by {{param|SessionMode}}}}
{{obsoleted|2.17}}
{{deleted|2.18}}
The desired usage mode of an End-to-End Session Context with this
particular Controller.
A Session Context MUST be used and no USP Messages are allowed
to be exchanged prior to establishment.
Setting the parameter to Require MUST result in the
establishment of a Session Context.
A Session Context MAY be used but is not required.
When setting the parameter to Allow, the Agent MUST NOT
initiate Session Context but MUST perpetuate any existing
Session Context or Controller-initiated Session Context.
A Session Context MUST NOT be used.
Setting the parameter to Forbid MUST result in the immediate
termination of any established Session Context.
The current status of the Session Context.
A new Session Context is being negotiated (i.e., a USP Record
with sequence_id of 1 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.
{{deprecated|2.16|because it is replaced by
{{param|MaxUSPRecordSize}}}}
{{obsoleted|2.18}}
{{deleted|2.19}}
The maximum size allowed by the MTP, in {{units}}, a USP Record
(payload(s) and header fields) that can be transmitted to the remote
endpoint.
When a size is set, a payload too large to transfer is segmented into
smaller payloads according to the maximal size the USP Record can be.
The smallest size, which can be configured, is 512 bytes.
A value of 0 means that the segmentation function of payloads 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.
A Subscription dictates how a USP Agent issues USP Notification
Messages to a USP Controller, executes an automated configuration
action, or both, as controlled by {{param|TriggerAction}}.
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.
Determines the action to take when the monitored event occurs.
Issue a USP message to the controller configured in
{{param|Recipient}}.
Change the Device's configuration as detailed in
{{param|TriggerConfigSettings}}.
Issue a USP message to the controller configured in
{{param|Recipient}}, and change the Device's configuration as
detailed in {{param|TriggerConfigSettings}}.
Each entry is a name-value pair representing the name of the data
model parameter to configure and the value to configure it with.
Each entry in the comma-separated list will use the following format:
<Parameter Name>=<Parameter Value>
The Parameter Value will be formatted per the value type, which means
that string values will be quoted while unsignedInt values will be
unquoted numeric values, etc..
When the monitored event occurs, then the {{param}} will be executed
if the {{param|TriggerAction}} is set to
{{enum|Config|TriggerAction}} or
{{enum|NotifyAndConfig|TriggerAction}}.
Unique identifier of the {{object}} itself, which is specific to the
USP Controller that creates the instance of the {{object}}.
This value is used as the ''subscription_id'' element of every
Notification message from a USP Agent to a USP Controller caused by
this subscription entry.
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 Path Name, Search Path, Command
reference, or Event reference that determines the element(s) 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}}.
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.
The following bullet points describe what is allowed as a value of
{{param}} based on the different values of the {{param|NotifType}}
parameter:
* ValueChange: may be either a Path Name or Search Path; if an Object
Path (one type of Path Name) then it is treated like a filter match
such that all supported parameters in all objects below this point
will be relevant for the subscription.
* ObjectCreation: may be either a Path Name or Search Path as long as
it only refers to a Multi-Instance Object; only the referenced
Multi-Instance Objects will be relevant for the subscription.
* ObjectDeletion: may be either a Path Name or Search Path as long as
it only refers to instances of a Multi-Instance Object; only the
referenced instances (wildcard references all instances over time)
of the Multi-Instance Objects will be relevant for the
subscription.
* OperationComplete: may be either a Path Name, Search Path, or
Command reference; if an Object Path (one type of Path Name) then
it is treated like a filter match such that all supported data
model commands in all objects below this point will be relevant for
the subscription.
* Event: may be either a Path Name, Search Path, or Event reference;
if an Object Path (one type of Path Name) then it is treated like a
filter match such that all supported Events in all objects below
this point will be relevant for the subscription.
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 parameter 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 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 parameter 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.
New instances of {{object}} are created with {{param|Status}} as
{{enum|Requested|Status}}. Once the command of the ''Operate'' begins
to be executed, then the the {{param|Status}} changes to
{{enum|Active|Status}}.
When the command of the ''Operate'' completes, then this {{object}}
instance is removed from this table, but not before the
{{param|Status}} transitions to either {{enum|Success|Status}} or
{{enum|Error|Status}} depending on whether the command of the
''Operate'' completed successfully or not.
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.
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 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.
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.
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.
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|##.LocalAgent.TransferComplete!}} event.
The {{datatype}} specifying the source file location. The HTTPS
transport MUST be supported, and the HTTP transport MAY 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|#.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|#.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|##.LocalAgent.TransferComplete!}} event.
The {{datatype}} specifying the destination file location. The
HTTPS transport MUST be supported, and the HTTP transport MAY 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|##.LocalAgent.TransferComplete!}} event.
The {{datatype}} specifying the destination file location. The
HTTPS transport MUST be supported, and the HTTP transport MAY 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|##.LocalAgent.TransferComplete!}} event.
The {{datatype}} specifying the source file location. The HTTPS
transport MUST be supported, and the HTTP transport MAY 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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
This command performs a DSL Single Ended Line Test - Physical Medium
Dependent (SELT-PMD) Uncalibrated Echo Response (UER).
This command is for the CPE, aka the Transmission Unit - Remote end
(TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD
management entity}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
This command performs a DSL Single Ended Line Test - Physical Medium
Dependent (SELT-PMD) Quiet Line Noise (QLN).
This command is for the CPE, aka the Transmission Unit - Remote end
(TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD
management entity}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
This command performs a DSL Single-Ended Line Test - Processed
(SELT-P).
This command is for the CPE, aka the Transmission Unit - Remote end
(TU-R).
Reference: ITU-T Recommendation {{bibref|G.996.2}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
Asynchronous Transfer Mode (ATM) object that contains the
{{object|Link}} interface and {{command|Diagnostics.F5Loopback()}}
diagnostics.
This command provides access to an ATM-layer F5 OAM loopback test.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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).
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
This command provides access to an IP-layer ping test.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
The CPE can not reach the requested Ping host address
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 the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
The CPE can not reach the requested TraceRoute host address
Indicates which IP address was used for TraceRoute.
The maximum number of instances in
{{object|DownloadDiagnostics().IncrementalResult}} that the
implementation will return.
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}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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 instances in
{{object|UploadDiagnostics().IncrementalResult}} that the
implementation will return.
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}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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-143|Appendix A.1}} defined in {{bibref|RFC862}} or a
UDP Echo Plus test defined in {{bibref|TR-143|Appendix A.1}}.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
The maximum number of instances in
{{object|IPLayerCapacity().IncrementalResult}} that the
implementation will return.
This command defines the IP Layer Capacity measurement configuration.
IP Layer Capacity measurement is specified in {{bibref|TR-471}}.
Data received in the IP Layer Capacity measurement do not require
storage on the device.
If {{param|AuthenticationEnabled}} is set to {{true}}, one of the
following combinations of {{param|AuthenticationCode}},
{{param|AuthenticationAlias}} and
{{param|AuthenticationKeyFileLocation}} MUST be met. Otherwise, the
client returns an error.
If only {{param|AuthenticationCode}} is provided, the client uses
the value directly as the key.
If both {{param|AuthenticationCode}} and
{{param|AuthenticationAlias}} are provided but
{{param|AuthenticationKeyFileLocation}} is not provided, the client
uses the {{param|AuthenticationCode}} as the key and the
{{param|AuthenticationAlias}} as key ID. The
{{object|IPLayerCapacityAuthCode}} table is ignored.
If only {{param|AuthenticationAlias}} is provided, the client uses
the {{object|IPLayerCapacityAuthCode}} table to derive the
{{param|IPLayerCapacityAuthCode.{i}.Alias}} to use as key ID,
and the
{{param|IPLayerCapacityAuthCode.{i}.AuthenticationKey}} as
the key.
If both {{param|AuthenticationAlias}} and
{{param|AuthenticationKeyFileLocation}} are provided, but
{{param|AuthenticationCode}} is not provided, the client uses
the {{param|AuthenticationAlias}} as key ID along with
{{param|AuthenticationKeyFileLocation}} as file location. The
{{object|IPLayerCapacityAuthCode}} table is ignored.
If only {{param|AuthenticationAlias}} is provided, and the
{{object|IPLayerCapacityAuthCode}} does not contain the
{{param|AuthenticationAlias}}, the client returns an error.
If only {{param|AuthenticationKeyFileLocation}} is provided, the file
specified MUST contain a single entry. Otherwise, the client returns
an error.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
The DNS Diagnostics object containing the
{{command|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.
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than
{{enum|Complete}}, the values of the other results parameters for
this test are indeterminate.
Unable to resolve DNSServer Name
Result Parameter to represent whether the NS Lookup was
successful or not.
Checks whether the input {{param|Username}} and {{param|Password}}
are valid for allowing access to the user interface on the device. If
not valid, then an indication of why they are not valid is output.
Indicates the response to request to check whether the
credentials are valid and, if not, why not. {{enum}}
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.
This command creates a time-limited web session. The web session will
be terminated when the life time of the session exceeds
{{param|AbsoluteTimeout}} or when no data is transmitted or received
for {{param|IdleTimeout}}.
{{param}} in {{units}} specifies the amount of time that a
session is may be active. When ''0'' is specified this feature is
disabled.
{{param}} in {{units}} specifies the amount of time that a
session may be idle before it is automatically terminated. When
''0'' is specified this feature is disabled.
Session identifier.
Absolute path component as defined in {{bibref|RFC3986|Section
3.3}} that can be used to access the session on the web
interface.
This terminates an active session ahead of any configured timeouts.
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.
This is the same as disabling and re-enabling the IP interface,
after which all associated IP addresses and prefixes MUST be refreshed.
If refreshing is not possible (e.g., due to a significant remaining lifetime of a prefix),
the implementation may choose to retain them instead of discarding them.
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 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.
Indicates availability of Sample statistics. {{enum}}
The {{enum|Trigger}} value is only used for triggering the Controller
to fetch the collected data and can only be used when
{{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}].
The transition from {{enum|Enabled}} to {{enum|Trigger}} to
{{enum|Enabled}} MUST be instantaneous and so will result in only a
single value change for notification purposes.
{{deprecated|2.16|because the periodic statistics are sent through a
USP {{event|Push!}} event}}
{{obsoleted|2.18}}
{{deleted|2.19}}
Collection is disabled.
Collection is enabled.
Collection is enabled and the Controller SHOULD now fetch the
collected data.
{{reference|the {{object|##.LocalAgent.Controller}} instance that
created {{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.
The USP Controller referenced by this parameter defines the set of
permissions to use when updating the {{object|Parameter}} table.
Furthermore, only the USP Controller referenced by this parameter
will receive a {{event|Push!}} Event (assuming it has an associated
Subscription), even if another USP Controller has an associated
Subscription.
An absolute time reference in UTC to determine when sample intervals
will complete. Each sample interval MUST complete at this reference
time plus or minus an integer multiple of {{param|SampleInterval}}.
{{param}} is used only to set the "phase" of the sample and fetch
intervals. The actual value of {{param}} can be arbitrarily far into
the past or future.
This time reference also determines when the {{event|Push!}} event
that is controlled by {{param|FetchSamples}} will occur. If
collection of periodic statistics is enabled and
{{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]
then each such {{event|Push!}} event MUST occur at this reference
time plus or minus an integer multiple of {{param|FetchSamples}} *
{{param|SampleInterval}} (the fetch interval).
If {{param}} is changed while collection of periodic statistics is
enabled, any stored samples are discarded, and the first sample
interval begins immediately.
The Unknown Time value defined in {{bibref|TR-106}} indicates that no
particular time reference is specified. That is, the CPE MAY locally
choose the time reference, and is required only to adhere to the
specified sample and fetch intervals.
If absolute time is not available to the CPE, its sample and fetch
interval behavior MUST be the same as if the {{param}} parameter was
set to the Unknown Time value.
For example, if {{param|SampleInterval}} is 3600 (an hour) and if
{{param}} is set to UTC midnight on some day (in the past, present,
or future) then sample intervals will complete on each UTC hour
(00:00, 01:00, 02:00 etc).
If, in addition, {{param|FetchSamples}} is 24, then the fetch
interval is 86400 (a day) and the {{event|Push!}} event will occur
every day at UTC midnight.
Note that, if {{param}} is set to a time other than the Unknown Time,
the first sample interval (which has to begin immediately) will
almost certainly be shorter than {{param|SampleInterval}}). This is
why {{param}} is defined in terms of when sample intervals complete
rather than start.
The number of sample intervals to be collected before triggering a
{{event|Push!}} event.
If this SampleSet is enabled and {{param}} is in the range
[1:{{param|ReportSamples}}] then a {{event|Push!}} event MUST be sent
on completion of every {{param}} sample intervals.
For example, if {{param|ReportSamples}} is 25 and {{param}} is 24,
then the CPE will store 25 values for each monitored parameter and
the {{event|Push!}} event will occur as the CPE stores each 24th of
25 sample intervals.
Periodic Statistics Push event for delivering a periodic statistics
report within a USP Notification message.
Periodic statistics parameter table for the report sent by this
event. This table contains entries for parameters whose values were
sampled.
{{reference}} This is the parameter being reported by the
Periodic Statistics mechanism.
{{list}} Each entry indicates the value of the referenced
parameter, as determined by
{{param|##.Parameter.{i}.SampleMode}}, during the sample
interval.
The statistics values in this comma-separated list MUST be in
time order, with the oldest one first and the most recent one
last.
If the {{param|##.Parameter.{i}.SampleMode}} parameter is not
present, or is inappropriate for the referenced parameter, the
statistics values MUST be collected in Current mode.
{{list}} Each entry indicates the number of {{units}} during
which data was collected for this parameter during the sample
interval.
Individual {{param}} values can be less than
{{param|##.SampleInterval}}, for several reasons, including:
: Any of the reasons for which {{param|##.SampleSeconds}} values
might be less than {{param|##.SampleInterval}}.
: The parameter doesn't exist, or was created or deleted during a
sample interval.
{{list}} Each entry is 0 if the sampled value is believed to be
valid, or 1 if an event that might affect the validity of the
sampled value occurred during the sample interval.
For example, if the parameter value were to be reset during the
sample interval then it would be appropriate to set {{param}} to
1.
Counts the number of times (since this object instance was last
enabled) that a newly-calculated sample value (accounting for
{{param|##.Parameter.{i}.SampleMode}}) transitioned from the "in
range" state to the "out of range" state, or between the "out of
range (low)" and "out of range (high)" states. The states are
defined as follows:
* "in range" : current value is greater than
{{param|##.Parameter.{i}.LowThreshold}} and less than
{{param|##.Parameter.{i}.HighThreshold}}.
* "out of range" : current value is less than or equal to
{{param|##.Parameter.{i}.LowThreshold}}, or greater than or
equal to {{param|##.Parameter.{i}.HighThreshold}}.
* "out of range (low)" : current value is less than or equal to
{{param|##.Parameter.{i}.LowThreshold}}.
* "out of range (high)" : current value is greater than or equal
to {{param|##.Parameter.{i}.HighThreshold}}.
Note that, if {{param|##.Parameter.{i}.LowThreshold}} and
{{param|##.Parameter.{i}.HighThreshold}} are both the same, the
threshold/failure mechanism is disabled, so the value of this
parameter will not increment.
This parameter can be incremented at any time during a sample
interval, and might be incremented more than once during a single
sample interval. For this reason, the CPE SHOULD place a locally
specified limit on the frequency at which it will notify the
Controller of such changes.
Parameters of non-numeric types cannot support the
threshold/failure mechanism. The value of this parameter MUST be
ignored for such parameters.
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 {{command}} 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.
Start the periodic statistics collection performing actions
equivalent to a {{command|ForceSample()}} command and transmission
performing a {{event|Push!}} event immediately, regardless of the
current values of the {{param|Enable}} and {{param|FetchSamples}}
parameters.
This command can be used for testing of the periodic statistics
collection mechanism and sample set but also to preempt any regular
schedule without affecting it.
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.
This command sends a magic packet over the CPE active Ethernet
interfaces.
This command represents a request to reset all statistics counters to
zero. Statistics are provided in
{{object|#.InterfaceSetting.{i}.Stats.}}.
This command allows the MAC key and MAC algorithm to be tested to see
if they produce an expected outcome. The command calculates a MAC for
{{param|InputString}} using the {{param|#.KeyValue}} and
{{param|#.MACKeyAlgorithm}} and compares that to the value of
{{param|InputMAC}}. If the values match, the output {{param|Match}}
is {{true}}.
The command calculates a MAC of {{param}} using the
{{param|#.KeyValue}} and {{param|#.MACKeyAlgorithm}}.
The command compares the calculated MAC to {{param}}.
{{param}} is {{true}} if the calculated MAC and
{{param|InputMAC}} are the same.
Reset all this object's statistics counters to zero.
This command is issued to delete the current active session.
This command empties the cache.
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.
Adds client authentication, will handling and extends statistics
This profile adds USP agent extensions for MQTT transport.
This profile adds USP controller extensions for MQTT transport.
{{deprecated|2.16|because it now contains a deprecated parameter}}
{{obsoleted|2.18}}
This profile adds USP controller extensions for MQTT transport.