9.2.4 UpdateSoftwareStatus

The UpdateSoftwareStatus Method allows a Client to provide the firmware status for a Device on the network.

The Client may be the SoftwareUpdateManager (see 4.2.5) or other administrative application that allows a human to provide information about a manual process.

This Method shall be called from an authenticated SecureChannel and from a Session that has access to the SoftwareUpdateAdmin Role (see 4.2.6).

Signature

UpdateSoftwareStatus(
 	[in]	0:String productInstanceUri,
	[in]	0:Boolean status,
	[in]	0:String softwareRevision
);
   
Argument Description
productInstanceUriThe unique identifier for the Device.
status

The status of the software.

If TRUE the firmware is up to date, otherwise, an update is required before the Device can be used on the network.

softwareRevisionThe version of the software which is running on the Device (status=TRUE) or needs to be installed on the Device (status=FALSE).

Method Result Codes (defined in Call Service)

Result Code Description
Bad_UserAccessDeniedThe Session does not have the permissions needed to call the Method.
Bad_NotFoundThe productInstanceUri does not refer to a known Device.

Table 19 specifies the AddressSpace representation for the UpdateSoftwareStatus Method.

Table 19 – UpdateSoftwareStatus Method AddressSpace Definition
Attribute Value
BrowseName2:UpdateSoftwareStatus
References NodeClass BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument [] 0:PropertyTypeMandatory