Deploy Software Updates operation
The Deploy Software Updates operation deploys the latest software updates from Microsoft to the specified collection. The updates must be synchronized with Microsoft updates and their content must be downloaded and deployed before they can be deployed to any target collection.
The following table describes the <items> XML elements for the Deploy Software Updates operation:
Elements for the <items> XML element and adapter request for the Deploy Software Updates operation
Element | Definition | Required |
|---|---|---|
<operation-name> | Specifies the name of the operation: create-collection | Yes |
<arguments> | Specifies a list of arguments required for this operation | Yes |
<target> | Specifies the connection information for the Microsoft System Center Configuration Manager application | No |
<software-updates-search-criteria> | Specifies the parent element for the following search elements:
| Yes |
<software-name> | Specifies the name of the software update to be deployed | Conditional; required if none of the other search criteria are specified |
<ci-id> | Specifies the unique configuration identification number of the software update that you want to deploy The <ci-id> element is unique only for the site. | Conditional; required if none of the other search criteria are specified |
<ci-unique-id> | Specifies the unique identification number of the software update that you want to deploy The <ci-unique-id> element is unique across different sites. | Conditional; required if none of the other search criteria are specified |
<bulletin-id> | Specifies the bulletin identification number for security updates released by Microsoft corporation to search for software updates The <bulletin-id> element can be maximum up to 64 characters. | Conditional; required if none of the other search criteria are specified |
<kb-article-id> | Specifies the knowledge base article ID that is used to search for software updates The <kb-article-id> element can be maximum up to 64 characters. | Conditional; required if none of the other search criteria are specified |
<severity> | Specifies the severity level to search for software updates Valid values:
| Conditional; required if none of the other search criteria are specified |
<deployment-name> | Specifies a logical name given to the software updates deployment assignment | Yes |
<deployment-description> | Specifies a description for the software updates deployment assignment | No |
<collection-id> | Specifies the collection ID to which you want to deploy software updates | Yes |
<deployment-type> | Specifies whether the software update deployment is required or not Valid values: Required, Available | No |
<send-wakeup-packets> | Indicates whether to send the Wake on LAN transmission to the client when the deadline for deploying the software update approaches Valid values: true, false (default) Note: The <send-wakeup-packets> element is valid only if the value of the <deployment-type> element is required. | No |
<status-message-level-detail> | Indicates the level of detailed messages to be sent to the user Valid values:
| No |
<dp-locality> | Specifies the flags that determine how the client obtains the distribution points, according to the distribution point locality Valid values:
| No |
<use-gmt-times> | Specifies whether to use the Universal Coordinated Time (UTC) for specifying time values Valid values: true (default), false | No |
<start-time> | Specifies the date and time, in the following format, from when the application deployment is offered Format: YYYmmDDhhMMss.MMMMMM+*** By default, the current system time is used. Note: The value for the <start-time> cannot be less than the current day minus 1 day. | No |
<enforcement-deadline> | Specifies the date and time, in the following format, from when the software update deployment is enforced Format: YYYYmmDDhhMMss.MMMMMM+*** By default, the current system time plus 7 days is considered as the enforcement deadline. Note: The value of the <enforcement-deadline> element must be greater than the <start-time>. This element is valid only if the value of the <purpose> element is required. | No |
<notify-user> | Specifies whether to notify the user when the software update is deployed and becomes available Valid values: true, false (default) | No |
<user-ui-experience> | Indicates if user notifications are displayed Valid values: true, false (default) | No |
<allow-activities-outside-maintenance-window> | Contains the following elements that specify the activities that a client can perform after reaching the deadline:
| No |
<software-updates-installation> | Specifies whether a client should install the software update Valid values: true, false (default) Note: The <software-installation> element is valid only if the value of the <deployment-type> element is required. | No |
<system-restart> | Specifies whether to restart the software update after the installation Valid values: true, false (default) Note: The <system-restart> element is valid only if the value of the <deployment-type> element is required. | No |
<suppress-reboot> | Specifies whether the client should not reboot the computer, if a reboot action is pending after the software update is deployed Valid values:
| No |
<non-compliance-criticality> | Specifies the non-compliance criticality of the software updates for the assignment Valid values: Any integer between 0 to 99 | No |
<send-detailed-non-compliance-status> | Specifies whether to send a detailed message when the software update is non-compliant Valid values: true, false (default) | No |
<log-compliance-to-win-event> | Specifies whether to log compliance status to Windows event logs Valid values: true, false (default) | No |
<disable-mom-alerts> | Specifies whether the client is configured to raise MOM alerts when the software update is deployed Valid values: true, false (default) | No |
<raise-mom-alerts-on-failure> | Specifies whether the client should raise the MOM alerts in case the software update fails to deploy Valid values: true, false (default) | No |
The following figure shows a sample adapter request for the Deploy Software Updates operation:
Sample adapter request for the Deploy Software Updates operation
<operation-name> deploy-software-updates</operation-name>
<timeout-secs>120</timeout-secs>
<arguments>
<software-updates-search-cretiria>
<software-name></software-name>
<ci-id></ci-id>
<ci-unique-id></ci-unique-id>
<bulletin-id>MS03-013</bulletin-id>
<kb-article-id></kb-article-id>
<severity></severity>
</software-updates-search-cretiria>
<deployment-name>Dep26Jul</deployment-name>
<deployment-description>Test 24 Jul1</deployment-description>
<collection-id>PRI00031</collection-id>
<deployment-type>Required</deployment-type>
<send-wakeup-packets>True</send-wakeup-packets>
<state-message-detail-level></state-message-detail-level>
<dp-locality>DP_DOWNLOAD_FROM_LOCAL</dp-locality>
<use-gmt-times>False</use-gmt-times>
<start-time>20130726221000.000000+***</start-time>
<enforcement-deadline>20140712101000.000000+***</enforcement-deadline>
<notify-user>True</notify-user>
<user-ui-experience>True</user-ui-experience>
<allow-activities-outside-maintenance-window>
<software-updates-installation>True</software-updates-installation>
<system-restart>True</system-restart>
</allow-activities-outside-maintenance-window>
<suppress-reboot>SUPPRESS_REBOOT_SERVERS</suppress-reboot>
<non-compliance-criticality>90</non-compliance-criticality>
<send-detailed-non-compliance-status>True</send-detailed-non-compliance-status>
<log-compliance-to-win-event></log-compliance-to-win-event>
<disable-mom-alerts>True</disable-mom-alerts>
<raise-mom-alerts-on-failure>True</raise-mom-alerts-on-failure>
</arguments>
</mssccm-request>
The following figure shows the adapter response for the sample request:
Sample adapter response for the Deploy Software Updates operation
<metadata>
<status>success</status>
<response-count>1</response-count>
</metadata>
<responses>
<response>
<metadata>
<target>config1</target>
<status>success</status>
<count>1</count>
</metadata>
<output>
<assignment-id>16777239</assignment-id>
<assignment-name><![CDATA[Dep26Jul]]></assignment-name>
<assignment-unique-id><![CDATA[{760DA479-7090-4289-A08E-0ABC316900D5}]]></assignment-unique-id>
<target-collection-id><![CDATA[PRI00031]]></target-collection-id>
</output>
</response>
</responses>
</mssccm-response>