createDeploymentForACatalogItem
You can use the CreateDeploymentForACatalogItem command to create a deployment for a catalog item with a deployment target.
Parameters
The CreateDeploymentForACatalogItem command includes the following parameters:
| # | Parameter | Data Type | Description |
|---|---|---|---|
| allowRestartOutsideOfMaintWindow | Boolean | Specify whether to allow machine restart outside of maintenance window. | |
| CreateUninstall | Boolean | This parameter can only be used on packages of Type 15 where you want to create both an install and an uninstall at the same time. The parameter value in this case should be True or False otherwise. | |
| deploymentTarget | Integer | Use one of the following values: 0 = Deploy To User 1 = Deploy To Computer | |
| DeploymentTechnology | Integer | Values are either SCCM 2012, or Altiris . | |
| deployToAllSites | Boolean | This parameter always has to be set to False because you can use this API to communicate with only one site. | |
| DistributionPoint | Integer | Use one of the following values: 1 = Run From DP 2 = Download From DP | |
| FunctionName | String | Use one of the following values: Install Uninstall Repair | |
| ignoreMaintenanceWindows | Boolean | Specify whether to ignore maintenance windows. | |
| isMandatoryOverSlowLink | Boolean | Specify whether this is mandatory even over slow links. | |
| isRblDPVisible | Boolean | Use to specify when a distribution point is available locally. The default value is True. | |
| isRblNoDPVisible | Boolean | Use to specify when no distribution point is available locally. The default value is True. | |
| isSelected | Boolean | True for a selected site. | |
| LanguageID | Integer | Enter 0 for English. | |
| makeAvailableToBootandPXE | Boolean | Make this task sequence available to boot media and PXE. | |
| makeMandatory | Boolean | Make the advertisement mandatory. | |
| noDistributionPoint | Integer | Use one of the following values: 1 = Don’t Run 2 = Download From RDP 3 = Run From RDP | |
| OSDProgram | String | Enter the OSDProgramName , or you can leave it blank. | |
| PackageType | Integer | Use one of the following values: 0, 7 = Software distribution package 4 = Task sequence 15 = Application | |
| priority | Integer | Use one of the following values: 1 = High 2 = Medium 3 = Low | |
| ProgramName | String | Enter a program name. | |
| rerunBehavior | Integer | Use one of the following values: 1 = Never Rerun 2 = Always Rerun 3 = Rerun Failed 3 = Rerun Succeeded | |
| showTaskSequenceProgress | Boolean | Show the task sequence execution progress. | |
| SiteServer | String | Site server string. | |
| siteText | String | Enter the name of the site, such as LAX or ORD . | |
| SMSPackageID | String | Enter the SMSPackageID of the catalog item. | |
| taskSeqDistributionPoint | Integer | Use one of the following values: 1 = Don’t Run 2 = Download From RDP 3 = Run From RDP | |
| Title | String | Name of the catalog item. | |
| useRemoteDPForTaskSequence | Boolean | Use a remote distribution point when no local distribution point is available. | |
| useUnprotectedDP | Boolean | Use an unprotected distribution point when no protected distribution point is available |
Return Value
Returns one of the following:
- Returns a 1 when successfully creating the deployment for a catalog item.
- Returns a 0 if the deployment was not created.
- Returns a -1 when encountering an exception.