createDeploymentForACatalogItem

App Portal 2017

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:

CreateDeploymentForACatalogItem Parameters

#

Parameter

Data Type

Description
1.  

allowRestartOutsideOfMaintWindow

Boolean

Specify whether to allow machine restart outside of maintenance window.
2.  

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.
3.  

deploymentTarget

Integer

Use one of the following values:

• 0 = Deploy To User
• 1 = Deploy To Computer
4.  

DeploymentTechnology

Integer

Values are either SCCM 2012, SCCM 2007, or Altiris.
5.  

deployToAllSites

Boolean

This parameter always has to be set to False because you can use this API to communicate with only one site.
6.  

DistributionPoint

Integer

Use one of the following values:

• 1 = Run From DP
• 2 = Download From DP
7.  

FunctionName

String

Use one of the following values:

• Install
• Uninstall
• Repair
8.  

ignoreMaintenanceWindows

Boolean

Specify whether to ignore maintenance windows.
9.  

isMandatoryOverSlowLink

Boolean

Specify whether this is mandatory even over slow links.
10.  

isRblDPVisible

Boolean

Use to specify when a distribution point is available locally. The default value is True.
11.  

isRblNoDPVisible

Boolean

Use to specify when no distribution point is available locally. The default value is True.
12.  

isSelected

Boolean

True for a selected site.
13.  

LanguageID

Integer

Enter 0 for English.
14.  

makeAvailableToBootandPXE

Boolean

Make this task sequence available to boot media and PXE.
15.  

makeMandatory

Boolean

Make the advertisement mandatory.
16.  

noDistributionPoint

Integer

Use one of the following values:

• 1 = Don’t Run
• 2 = Download From RDP
• 3 = Run From RDP
17.  

OSDProgram

String

Enter the OSDProgramName, or you can leave it blank.
18.  

PackageType

Integer

Use one of the following values:

• 0, 7 = Software distribution package
• 4 = Task sequence
• 15 = Application
19.  

priority

Integer

Use one of the following values:

• 1 = High
• 2 = Medium
• 3 = Low
20.  

ProgramName

String

Enter a program name.
21.  

rerunBehavior

Integer

Use one of the following values:

• 1 = Never Rerun
• 2 = Always Rerun
• 3 = Rerun Failed
• 3 = Rerun Succeeded
22.  

showTaskSequenceProgress

Boolean

Show the task sequence execution progress.
23.  

SiteServer

String

Site server string.
24.  

siteText

String

Enter the name of the site, such as LAX or ORD.
25.  

SMSPackageID

String

Enter the SMSPackageID of the catalog item.
26.  

taskSeqDistributionPoint

Integer

Use one of the following values:

• 1 = Don’t Run
• 2 = Download From RDP
• 3 = Run From RDP
27.  

Title

String

Name of the catalog item.
28.  

useRemoteDPForTaskSequence

Boolean

Use a remote distribution point when no local distribution point is available.
29.  

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.

App Portal / App Broker 2017 Administration Guide

18 July 2017

 Copyright Information | Flexera Software

Open topic with navigation