Deploy Application operation


The Application Deployment operation deploys the application to a specified collection. To deploy an application, you must create or import an application to Microsoft System Center Configuration Manager. 

The following table describes the <items> XML elements for the Application Deployment operation:

Elements for the <items> XML element and adapter request for the Application Deployment operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: deploy-application

Yes

<arguments>

Specifies the list of arguments required for this operation

Yes

<target>

Specifies the connection information for the Microsoft System Center Configuration Manager application

Valid values: The value specified for the <target> element must be the same as that specified for the name attribute of the <config>element in the adapter configuration.

Default value: The first configuration defined in the adapter configuration

No

<applications-search-criteria>

Contains the following elements used to search for applications

  • <ci-id>
  • <display-name>
  • <ci-unique-id>

Note: You can search only those applications for which the content is downloaded.

Yes

<ci-id>

Specifies the unique configuration identification number of the application that you want to deploy

The <ci-id> element is unique only for the site.

Conditional; required if either <display-name> or <ci-unique-id> is not specified

<display-name>

Specifies the localized display name of the application that you want to deploy

Conditional; required if either <ci-id> or <ci-unique-id> is not specified

<ci-unique-id>

Specifies the unique identification number of the application that you want to deploy

The <ci-unique-id> element is unique across different sites.

Conditional; required if either <ci-id> or <display-name> is not specified

<collection-id>

Specifies a string identifier for the collection where the advertisement is announced

Yes

<assignment-name>

Specifies a name given to the assignment for deploying an application

Yes

<assignment-description>

Specifies a description for the application deployment assignment

No

<action>

Specifies the action to be performed on the application

Valid values: Install, Uninstall

Yes

<purpose>

Specifies whether the deployment of the application is mandatory

Valid values: Required, Available

Note: If you specify the <action> element as Uninstall, then the value of the <purpose> element should be required.

Yes

<require-admin-approval>

Indicates whether the deployment of an application requires the approval of an administrator

Valid values: true, false (default)

Note: The <require-admin-approval> element is valid only if the value of the <purpose> element is available.

No

<predeploy-software>

Indicates whether the application should be pre-deployed on the client software

Valid values: true, false (default)

Note: The <predeploy-software> element is valid only if the value of the <purpose> element is required.

No

<send-wakeup-packets>

Indicates whether to send the Wake on LAN transmission to the client when the deadline for deploying the application approaches

Valid values: true, false (default)

Note: The <send-wakeup-packets> element is valid only if the value of the <purpose> element is required.

No

<use-gmt-time>

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 application 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 application is deployed and becomes available

Valid values: true, false (default)

No

<allow-activities-outside-maintenance-window>

Contains the following elements that specify the activities that a client can perform on the application after reaching the deadline:

  • <software-installation>
  • <system-restart>

No

<software-installation>

Specifies whether a client should install the application

Valid values: true, false (default)

Note: The <software-installation> element is valid only if the value of the <purpose> element is required.

No

<system-restart>

Specifies whether to restart the application after the installation

Valid values: true, false (default)

Note: The <system-restart> element is valid only if the value of the <purpose> element is required.

No

<priority>

Specifies the priority of the application deployment

Valid values: low, medium (default), high

No

<suppress-reboot>

Specifies whether the client should not reboot the computer, if a reboot action is pending after the application is deployed

Valid values: SUPPRESS_REBOOT_WORKSTATIONS, SUPPRESS_REBOOT_SERVERS

No

<disable-mom-alerts>

Specifies whether the client is configured to raise MOM alerts when the application is deployed

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

<non-compliance-criticality>

Specifies the application's non-compliance criticality for the assignment

Valid values: Any integer between 0 to 99

No

<raise-mom-alerts-on-failure>

Specifies whether the client should raise the MOM alerts in case the application fails to deploy

Valid values: true, false (default)

No

<send-detailed-non-compliance-status>

Specifies whether to send a detailed message when the application is non-compliant

Valid values: true, false (default)

No

<user-ui-experience>

Specifies whether a user notification is displayed

Valid values: true, false (default)

No

<state-message-priority>

Specifies the priority of the status message

Valid values:

  • Urgent
  • High
  • Normal (default)
  • Low

No

The following figure shows a sample adapter request for the Deploy Application operation:

Sample adapter request for the Deploy Application operation

 <mssccm-request>
      <operation-name>deploy-application</operation-name>
      <timeout-secs>120</timeout-secs>
      <arguments>
          <applications-search-cretiria>     
             <ci-id></ci-id>
             <display-name>Microsoft Office Communicator 2007 R2</display-name>
             <ci-unique-id></ci-unique-id>
          </applications-search-criteria>
          <collection-id>PRI00031</collection-id>
          <assignment-name>AppAssign26Jul</assignment-name>
          <assignment-description>Test</assignment-description>
          <action>Install</action>
          <purpose>Available</purpose>
          <require-admin-approval>True</require-admin-approval>
          <predeploy-software>True</predeploy-software>
          <send-wakeup-packets>True</send-wakeup-packets>
          <use-gmt-times>True</use-gmt-times>
          <start-time>20130726163000.000000+***</start-time>
          <enforcement-deadline>20141012101000.000000+***</enforcement-deadline>
          <notify-user>True</notify-user>
          <allow-activities-outside-maintenance-window>
              <software-installation>True</software-installation>
              <system-restart>True</system-restart>
          </allow-activities-outside-maintenance-window>
          <priority>Medium</priority>
          <suppress-reboot>SUPPRESS_REBOOT_SERVERS</suppress-reboot>
          <disable-mom-alerts>True</disable-mom-alerts>
          <log-compliance-to-win-event>True</log-compliance-to-win-event>
          <non-compliance-criticality>90</non-compliance-criticality>
          <raise-mom-alerts-on-failure>True</raise-mom-alerts-on-failure>
          <send-detailed-non-compliance-status>True</send-detailed-non-compliance-status>
          <user-ui-experience>True</user-ui-experience>
          <state-message-priority>Low</state-message-priority>
      </arguments>
</mssccm-request>

The following figure shows the adapter response for the sample request:

Sample adapter response for the Deploy Application operation

   <mssccm-response>
      
<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>16777252</assignment-id>
              
<assignment-name><![CDATA[AppAssign26Jul]]></assignment-name>
     
<assignment-unique-id><![CDATA[{760DA520-7090-4208-A08E-0ABC316270D5}]]></assignment-unique-id>
              
<target-collection-id><![CDATA[PRI00031]]></target-collection-id>
         
</output>
        
</response>
       
</responses>
      
</mssccm-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*