3.1.4.13.3.1 ExecuteSPDeployUpdate2RequestBody

Describes the update and deployment action.

  
 <xsd:complexType name="ExecuteSPDeployUpdate2">
   <xsd:sequence>
     <xsd:element minOccurs="1" maxOccurs="1" name="updateId" nillable="true" type="xsd:string"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="revisionNumber" type="xsd:int"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="deploymentAction" type="xsd:int"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="targetGroupId" nillable="true" type="xsd:string"/>
     <xsd:element minOccurs="0" maxOccurs="1" name="adminName" nillable="true" type="xsd:string"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="deadline" type="xsd:dateTime"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="isAssigned" type="xsd:boolean"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="goLiveTime" type="xsd:dateTime"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="downloadPriority" type="xsd:int"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="deploymentGuid" nillable="true" type="xsd:string"/>
     <xsd:element minOccurs="1" maxOccurs="1" name="translateSqlException" type="xsd:boolean"/>
     <xsd:element minOccurs="0" maxOccurs="1" name="failIfReplica" type="xsd:boolean"/>
     <xsd:element minOccurs="0" maxOccurs="1" name="isReplicaSync" type="xsd:boolean"/>
   </xsd:sequence>
 </xsd:complexType>

adminName: This field MUST be present. It represents the name of the approver. The name SHOULD follow the domain\username format.

deadline: This field MUST be present. It represents the date and time by which the Windows Update Agent (WUA) will enforce the specified action on any computer in the specified target group. Before the deadline has been reached, a user on that computer is prompted before executing the specified option. If a deployment action has no deadline, the date and time MUST be set to a value that is equivalent to 23:59:59.9999999, December 31, 9999; exactly one 100-nanosecond tick before 00:00:00, January 1, 10000. If the deadline has already passed when this operation is called, the specified action will take effect immediately on any computer in the specified target group.

deploymentAction: This field MUST be present and MUST be one of the following values:

Value

Action

Description

0

Install

Any client computer in the specified target group can install the update, if applicable. If a deadline is specified and the deadline is reached, the client computer MUST install the update, if applicable.

1

Uninstall

Any client computer canuninstall the specified update, if possible.

2

NotApproved

Exclude the update from any computer in the specified target group.

deploymentGuid: This field denotes the GUID of the deployment. It is present when replicating deployments of a USS to DSS, as deployment GUIDs MUST be the same. If the deployment is not part of a USS/DSS replica synchronization, this field SHOULD be empty.

downloadPriority: This field MUST be present. Client computers use this value to prioritize downloads of contents associated with the approved update. The value is as follows:

Value

Meaning

0

High priority

1

Normal priority (This SHOULD be the default value.)

2

Low priority

failIfReplica: This field MUST be present. It defines whether or not the deployment SHOULD fail if executed on a replica WSUS server. It MUST be set to 1 to perform the check, and MUST be set to 0 otherwise. Deployment is only approved on nonreplica servers.

goLiveTime: This field MUST be present. It describes when the update will be available for client computers to apply. Date and time are in UTC. The format of the string is defined in [ISO/IEC9075-2:2008].

isAssigned: This field MUST be present. It MUST be set to TRUE, if the deployment is available for Windows Automatic Update. Otherwise, the deployment action has to be done manually on the targeted client computer.

isReplicaSync: This field MUST be present. It SHOULD be set to FALSE. It is intended for internal use only.

revisionNumber: This field contains the revision number of the update that has been approved. This field in combination with updateId comprises the revision of the update.

targetGroupId: This field MUST be present. It contains the GUID of the target group for which this update is approved.

translateSqlException: This field MUST be present. It specifies whether or not errors observed by the database server when applying the deployment are translated to common WSUS exceptions. If this field is set to FALSE, a generic database error is returned.

updateId: This field MUST be present. It contains the GUID of the update that has been approved.