{{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()}}
{{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.
This command allows or disallows EasyMesh traffic separation
{{bibref|EasyMesh|Section 19.1}}. If {{param|Enable}} is {{true}} then
the parameters defining traffic separation details can also be input
with this command.
This command applies to all EasyMesh Agent devices in the Wi-Fi
network.
This command can configure
{{object|#.Device.{i}.SSIDtoVIDMapping.{i}.}} and
{{param|#.Device.{i}.TrafficSeparationAllowed}}.
Status is to be returned after implementation or failed implementation
on all agents/devices/APs in this Multi-AP network.
: {{true}}: EasyMesh traffic separation is allowed.
: {{false}}: EasyMesh traffic separation is not allowed.
The Service Set Identifier (SSID) to VLAN ID (VID) mapping for
EasyMesh traffic separation {{bibref|EasyMesh}}. Consists of a
table of pairs of {{param|SSID}} and corresponding {{param|VID}}.
If this input is not provided, then existing
{{object|##.Device.{i}.SSIDtoVIDMapping.{i}.}} apply.
The SSID name.
The VLAN ID (VID).
Indicates the type of outcome of the request to allow or disallow
EasyMesh traffic separation. {{enum}}
Indicates successful implementation on all agents/devices/APs
in this Multi-AP network.
This command allows or disallows EasyMesh service prioritization
{{bibref|EasyMesh|Section 20}}. If {{param|Enable}} is {{true}} then
the parameters defining service prioritization details can also be
input with this command.
This command can configure {{object|#.Device.{i}.SPRule.{i}.}},
{{param|#.Device.{i}.DSCPMap}} and
{{param|#.Device.{i}.ServicePrioritizationAllowed}}.
This command applies to all EasyMesh Agent devices in the Wi-Fi
network.
Status is to be returned after implementation or failed implementation
on all agents/devices/APs in this Multi-AP network.
: {{true}}: EasyMesh service prioritization is allowed.
: {{false}}: EasyMesh service prioritization is not allowed.
This object describes a list of service prioritization (SP) rules
{{bibref|EasyMesh}}.
If this input is not provided, then existing
{{object|##.Device.{i}.SPRule.{i}.}} apply.
Service prioritization rule Identifier.
Rule Precedence – higher number means higher priority.
Rule Output. The value of, or method used to select the 802.1Q
C-TAG Priority Code Point (PCP) output value.
Indicates if the rule always matches.
A hexadecimal string of 64 PCP values (one octet per value)
corresponding to the DSCP markings 0x00 to 0x3F, ordered by
increasing DSCP value. Each octet is in the range 0x00 – 0x07. This
is used to select a PCP value if a Service Prioritization Rule
specifies Rule Output: 0x08.
If this input is not provided, then the existing
{{param|#.Device.{i}.DSCPMap}} applies.
Indicates the type of outcome of the request to allow or disallow
EasyMesh service prioritization. {{enum}}
Indicates successful implementation on all agents/devices/APs
in this Multi-AP network
Request to initiate a channel scan. The operating classes, and list of
channels for each operating class, are input. For 2.4GHz and 5GHz
bands, only 20MHz operating classes are valid inputs.
This command should result in updating
{{object|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.}}
Indicates the type of outcome of the request to initiate a channel
scan. {{enum}}
Request to enable or disable this radio.
This command can result in updating {{param|Enabled}}.
: {{true}}: this radio is to be enabled.
: {{false}}: this radio is to be disabled.
Indicates the type of outcome of the request to enable or disable
this radio. {{enum}}
Request a restart of the Wi-Fi subsystem.
Indicates the type of outcome of the request to restart the Wi-Fi
subsystem. {{enum}}
Disallow or allow EasyMesh {{bibref|EasyMesh}} controller-initiated
station (STA) steering on this device.
This command can configure {{param|STASteeringState}}.
: {{true}}: EasyMesh controller-initiated station steering
disallowed;
: {{false}}: EasyMesh controller-initiated station steering
allowed.
Indicates the type of outcome of the request to allow or disallow
EasyMesh controller-initiated station steering. {{enum}}
This command sets the upper limit on transmit power
{{param|TransmitPowerLimit}} for this radio and
{{param|OperatingClass}}.
This command can configure
{{param|#.CurrentOperatingClassProfile.{i}.TransmitPowerLimit}}.
This is the upper limit on nominal transmit Equivalent
Isotropically Radiated Power (EIRP) that this radio can use for the
{{param|OperatingClass}}. In units of decibels relative to 1 mW
{{units}}.
The Operating Class per {{bibref|802.11-2020|Table E-4}} of the
radio. Note that the Operating Class identifies the band and
channel width.
Indicates the type of outcome of the request to set a transmit
power limit. {{enum}}
This command sets preferred backhaul links for EasyMesh
{{bibref|EasyMesh}} backhaul.
Indicates preferred backhaul links for EasyMesh {{bibref|EasyMesh}}
backhaul. Consists of a table of pairs of MAC addresses. For a
WI-Fi connection pair, an entry contains the BSSID and bSTA MAC
address. For a wired connection pair, an entry contains the
interface MAC addresses. This command applies to all EasyMesh Agent
devices in the Wi-Fi network.
Status is to be returned after implementation or failed
implementation on all agents/devices/APs in this Multi-AP network.
The MAC address of the BSS, or similar Ethernet interface, on
this preferred backhaul link.
The MAC address of the backhaul STA (bSTA), or similar Ethernet
interface, on this preferred backhaul link.
Indicates the type of outcome of the request to set preferred
backhaul links. {{enum}}
Indicates successful implementation of all preferred backhaul
links in this Multi-AP network.
This command specifies an {{param|SSID}} for fronthaul use across this
Wi-Fi Multi-AP network, or on this single-AP. Also specifies the
{{param|PassPhrase}}, whether to add or remove this SSID, and specifies
the {{param|Band}} for each {{param|SSID}}.
This command applies to all EasyMesh Agent devices in the Wi-Fi
network, or to this AP in the single-AP case.
This command can be used to set only {{param|PassPhrase}} if
{{param|SSID}} matches an existing {{param|#.SSID.{i}.SSID}} for this
{{param|Band}} for fronthaul use across this Wi-Fi Multi-AP network.
This command can configure {{object|#.SSID.{i}}}.
Status is to be returned after implementation or failed implementation
on all agents/devices/APs in this Multi-AP network.
The SSID for fronthaul use across this Wi-Fi Multi-AP network.
Indicates whether to add or remove this {{param|SSID}}.
: {{true}}: add this SSID,
: {{false}}: remove this SSID.
Status is to be returned after implementation or failed
implementation on all agents/devices/APs in this Multi-AP network.
If set to {{true}}, and this {{param|SSID}} already exists for this
{{param|Band}}, then there is no change to the {{param|SSID}}, but
the {{param|PassPhrase}} is set.
The WPA2 Passphrase and/or SAE password for this {{param|SSID}}.
The band(s) for which this {{param|SSID}} applies. {{enum}}
If this input is not provided, then a value of {{enum|All}}
applies.
Applies to all bands
2.4 GHz band
The entire 5 GHz band
The entire 6 GHz band
5 GHz UNII-1 band, 5.15 to 5.25 GHz
5 GHz UNII-2 band, 5.25 to 5.725 GHz
5 GHz UNII-3 band, 5.725 to 5.85 GHz
5 GHz UNII-4 band, 5.85 to 5.925 GHz
6 GHz UNII-5 band, 5.925 to 6.425 GHz
6 GHz UNII-6 band, 6.425 to 6.525 GHz
5 GHz UNII-7 band, 6.525 to 6.875 GHz
5 GHz UNII-8 band, 6.875 to 7.125 GHz
Indicates the type of outcome of the request to set the SSID.
{{enum}}
Indicates successful implementation on all agents/devices/APs
in this Multi-AP network
Enables/disables the use of Dynamic Frequency Selection (DFS) channels
on this device.
This command can configure {{param|#DFSEnable}}.
: {{true}}: the use of Dynamic Frequency Selection (DFS) channels
is allowed;
: {{false}}: the use of Dynamic Frequency Selection (DFS) channels
is disallowed;
Indicates the type of outcome of the request to allow or disallow
the use of Dynamic Frequency Selection (DFS) channels. {{enum}}
This command requests to set the Anticipated Channel Preference. The
operating classes, and list of channels for each operating class, are
input. For 2.4GHz and 5GHz bands, only 20MHz operating classes are
valid inputs.
Indicates the type of outcome of the request to set the anticipated
channel preference. {{enum}}
This command disallows Mirrored Stream Classification Service (MSCS)
service prioritization to particular STA(s). {{bibref|EasyMesh}}
This command applies to all EasyMesh Agent devices in the Wi-Fi
network.
This command configures {{param|#.MSCSDisallowedStaList}}.
List of STAs for which MSCS operation is disallowed.
Indicates the type of outcome of the request to disallow MSCS
service prioritization to particular STA(s) {{enum}}
This command disallows Stream Classification Service (SCS) service
prioritization to particular STA(s). {{bibref|EasyMesh}}
This command applies to all EasyMesh Agent devices in the Wi-Fi
network.
This command can configure {{param|#.SCSDisallowedStaList}}.
List of STAs for which SCS operation is disallowed.
Indicates the type of outcome of the request to disallow SCS
service prioritization to particular STA(s). {{enum}}
This command configures each of the descriptor elements for Mirrored
Stream Classification Service (MSCS), Stream Classification Service
(SCS), or QoS Management. {{bibref|EasyMesh}}.
This command can configure {{object|#QMDescriptor.{i}.}}.
If {{param|QMDescriptor.{i}.DescriptorElement}} is for SCS or MSCS, the
AP adds/changes/removes the rule according to the descriptor element
request type.
If a {{param|QMDescriptor.{i}.DescriptorElement}} is a QoS Management
DSCP Policy, the AP sends it to the STA identified by the
{{param|QMDescriptor.{i}.ClientMAC}}.
This object contains a table of {{param|DescriptorElement}}.
MAC address of the Station (STA) for which this descriptor
applies.
The descriptor element. One of:
: MSCS descriptor element (as described in
{{bibref|802.11-2020|Section 9.4.2.243}}, or
: SCS descriptor element (as described in
{{bibref|802.11-2020|Section 9.4.2.121}}, or
: QoS Management DSCP policy element (as described in
{{bibref|RFC8325|Section 5.3}}).
Indicates the type of outcome of the request to configure
descriptor elements. {{enum}}
This command sets the spatial reuse configuration of this radio.
Applies only to Wi-Fi 6 and possibly later generations of radios.
Acronyms: Spatial Reuse Group (SRG), Overlapping Basic Service Set
(OBSS), Preamble Detection (PD).
This command can configure {{object|#SpatialReuse.}}.
If some input parameter(s) are not provided, then the corresponding
existing parameter in {{object|#SpatialReuse.}} applies.
Indicates the type of outcome of the request to set the spatial
reuse configuration of this radio. {{enum}}
This parameter represents a request to initiate a channel scan on this
radio on the given channel using a specific {{param|DwellTime}}. This
command should result in updating
{{object|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.}}
Indicates the type of outcome of the request to initiate a channel
scan. {{enum}}
This parameter represents a request to initiate a full scan on this
radio, including all channels supported by this radio, for a specific
{{param|DwellTime}} and {{param|HomeTime}}. This command will result in
updating
{{object|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.}}
Indicates the type of outcome of the request to initiate a full
band scan. {{enum}}
{{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.
A {{object}} Event that was the result of a reboot triggered
locally on the Device (NOT as a result of a
{{command|#.Reboot()}} Command or other remote trigger, e.g.
another remote management protocol)
A {{object}} Event that was the result of a reboot triggered
via the {{command|#.Reboot()}} Command or other remote
trigger, e.g. another remote management protocol
A {{object}} Event that was the result of a factory reset
triggered locally on the Device or remotely (as a result of a
{{command|#.FactoryReset()}} Command or other remote trigger,
e.g. another remote management protocol), which is to be used
when the Agent cannot differentiate between local and remote
A {{object}} Event that was the result of a factory reset
triggered locally on the Device (NOT as a result of a
{{command|#.FactoryReset()}} Command or other remote trigger,
e.g. another remote management protocol)
A {{object}} Event that was the result of a factory reset
triggered via the {{command|#.FactoryReset()}} Command or
other remote trigger, e.g. another remote management protocol
{{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.
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-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.
IPDR Streaming Protocol {{bibref|IPDR-SP}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
IPDR File Transfer Protocol {{bibref|IPDR-FTP}}
{{deprecated|2.15|because IPDR Bulk Data Collection is not
supported in USP}}
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}}
Used with the IPDR Streaming and File Protocols.
{{bibref|IPDR-XDR}} {{deprecated|2.15|because IPDR Bulk Data
Collection is not supported in USP}}
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|Device.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}}
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}}
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}}
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}}
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}}
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}}
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}}
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).
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)
{{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}}
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 usese 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.
{{datatype|expand}}
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|.LocalAgent.Subscription.{i}.}} instance that references it
Determines whether to disable this {{object}} instance after the
{{event|Triggered!}} Event has been invoked.
The {{object}} will generate events as long as the
{{param|Enable}} 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|Device.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 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 any of the {{param|##.Threshold.{i}.ThresholdParam}}s that are
in the {{param|##.Threshold.{i}.ReferencePath}} change and the
threshold test conditation changes from {{false}} to {{true}}, the
Triggered Event will be invoked. The Triggered Event will only be
eligible for retriggering if the test condition is fulfilled again.
The parameter ({{param|.LocalAgent.Threshold.{i}.ReferencePath}}
and {{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) for which
the threshold has been triggered.
The new ({{param|.LocalAgent.Threshold.{i}.ReferencePath}} and
{{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) Value.
Schedule a ''Timer!'' event on the associated {{object}}.
{{deprecated|2.14|because it was replaced by a more flexible
asynchronous {{command|Device.ScheduleTimer()}}}}
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|Device.ScheduleTimer()}}}}
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 commmand 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.
{{numentries}}
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.
{{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.
{{deprecated|2.15|because it is replaced by {{param|SessionMode}}}}
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.
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.
{{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 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.
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.
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.
Top level object for dynamically managed software applications.
Install one or more Deployment Units (DUs) to the associated
{{object}}.
The {{datatype}} 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-181i2|Annex C}}.
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 is 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 7002 (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
7004 (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 7223 (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 7225 (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 7226 (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 7227 (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 7229
(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 7229 (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 was issued
# Any Deployment Unit that was present when the last Boot (with cause
of a factory reset) event was issued, but was subsequently
uninstalled and is now not present, MUST be installed with the
version that was present when the last Boot (with cause of a
factory reset) 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) event 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-181i2|Annex C}}.
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-181i2|Annex
C}}.
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 {{datatype}} used by the most recent
{{command|#.InstallDU()}} or {{command|Update()}} 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-181i2|Annex
C}}.
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 {{datatype}} 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-106|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 be {{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.
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}}
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.
The {{datatype}} 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.
The {{datatype}} 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.
The {{datatype}} 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.
The {{datatype}} 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.
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 {{object|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 defines access to other WiFi SSIDs that this device is
able to receive.
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 represents a request to reset or reboot the Wi-Fi
sub-system without resetting or rebooting the device.
This command requests the Wi-Fi backhaul link to be steered to
associate to a different BSS when the device is working as a bridge
in a mesh network. The device needs to already have the necessary
credentials for the switch to happen.
The {{param|TargetBSS}} should be an instance of a
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.BSSID.
Indicates the response to the Wi-Fi backhaul steering request.
{{enum}}
This command represents a request to disassociate this associated
device.
Indicates the response to the request to disassociate an
associated device. {{enum}}
This command requests initiation of a BSS Transition Management (BTM)
request to influence this client's roaming behavior to another BSS as
defined in {{bibref|802.11-2020|Section 9.6.13.9}}.
Indicates the response to the BSS Transition Management (BTM)
request. {{enum}}
The event is generated when an Associated Device (STA) associates to
a BSS.
The event is generated when an Associated Device (STA) disassociates
from a BSS.
The event is generated when an Associated Device (STA) fails to
connect to a BSS.
This command requests initiation of a Remote Measurement request to
retrieve measurement data from a BSS on this radio. Upon receipt of
this request, this radio is to initiate a measurement of the output
{{param|SignalStrength}} and {{param|Noise}} for the indicated input.
Indicates the response to the Remote Measurement request.
{{enum}}
This command represents a request to initiate a Clear Channel
Assessment (CCA) measurement scan on this radio on the given channel
using a specific {{param|DwellTime}}.
Indicates the response to the request to initiate a Clear Channel
Assessment (CCA) measurement. {{enum}}
Initiates a Wi-Fi Protected Setup (WPS) Push Button Configuration
(PBC) process as defined in {{bibref|WPS 2.0}} .
Indicates the response to the request to start Wi-Fi Protected
Setup (WPS) Push Button Configuration (PBC). {{enum}}
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.
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
{{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.
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.
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}}, {{param|SAEPassphrase}}, 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}},
{{enum|WPA3-Enterprise|ModesSupported}}, or
{{enum|WPA-WPA2-Enterprise|ModesSupported}}.
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}}
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.
{{reference|the {{object|Device.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|Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.}}
table. Furthermore, only the USP Controller referenced by this
parameter will have access to the {{param|Parameter.{i}.Values}},
{{param|Parameter.{i}.SampleSeconds}},
{{param|Parameter.{i}.SuspectData}} and
{{param|Parameter.{i}.Failures}} 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 {{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.
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.
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
This profile adds USP agent extensions for MQTT transport.
This profile adds USP controller extensions for MQTT transport.