Edit

Share via

Add-CMScriptDeploymentType

Module:
ConfigurationManager Module

Add a script installer deployment type.

Syntax

ByAppNameScript (Default) 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -ApplicationName <String>
    -ScriptLanguage <ScriptLanguage>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-ForceScriptDetection32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-ScriptFile <String>]
    [-ScriptText <String>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppId 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -ProductCode <String>
    -ApplicationId <Int32>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppName 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -ProductCode <String>
    -ApplicationName <String>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppValue 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -ProductCode <String>
    -InputObject <IResultObject>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppIdDetectionClause 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -AddDetectionClause <DetectionClause[]>
    -ApplicationId <Int32>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-DetectionClauseConnector <Hashtable[]>]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-GroupDetectionClauses <String[]>]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppNameDetectionClause 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -AddDetectionClause <DetectionClause[]>
    -ApplicationName <String>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-DetectionClauseConnector <Hashtable[]>]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-GroupDetectionClauses <String[]>]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppValueDetectionClause 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -AddDetectionClause <DetectionClause[]>
    -InputObject <IResultObject>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-DetectionClauseConnector <Hashtable[]>]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-GroupDetectionClauses <String[]>]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppIdScript 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -ApplicationId <Int32>
    -ScriptLanguage <ScriptLanguage>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-ForceScriptDetection32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-ScriptFile <String>]
    [-ScriptText <String>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppValueScript 

Add-CMScriptDeploymentType
    -DeploymentTypeName <String>
    -InstallCommand <String>
    -InputObject <IResultObject>
    -ScriptLanguage <ScriptLanguage>
    [-ContentLocation <String>]
    [-CacheContent]
    [-ContentFallback]
    [-EnableBranchCache]
    [-EstimatedRuntimeMins <Int32>]
    [-Force32Bit]
    [-ForceScriptDetection32Bit]
    [-InstallationBehaviorType <InstallationBehaviorType>]
    [-InstallWorkingDirectory <String>]
    [-LogonRequirementType <LogonRequirementType>]
    [-MaximumRuntimeMins <Int32>]
    [-RebootBehavior <PostExecutionBehavior>]
    [-RepairCommand <String>]
    [-RepairWorkingDirectory <String>]
    [-RequireUserInteraction]
    [-ScriptFile <String>]
    [-ScriptText <String>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-SourceUpdateProductCode <String>]
    [-UninstallCommand <String>]
    [-UninstallContentLocation <String>]
    [-UninstallOption <UninstallContentSetting>]
    [-UninstallWorkingDirectory <String>]
    [-UserInteractionMode <UserInteractionMode>]
    [-AddRequirement <Rule[]>]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to add a Script Installer deployment type to an application. This deployment type can be a script or a program that installs content or does an action. You use this deployment type for setup.exe installers or script wrappers.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Add a script installer deployment type to an application

This command adds the script deployment type named ScriptDT01 to the application named Application01.

Add-CMScriptDeploymentType -ApplicationName "Application01" -DeploymentTypeName "ScriptDT01" -InstallCommand 'appsetup.exe' -ForceScriptDetection32Bit

For more complex examples, see Set-CMScriptDeploymentType.

Parameters

-AddDetectionClause

Specify an array of detection method clauses for this deployment type. To create a detection clause, use one of the following cmdlets:

Save the output of these cmdlets into a variable. Then specify those variables as an array for this parameter. For example, -AddDetectionClause $clauseFile1,$clauseFile2,$clauseFile3.

You can also use Get-CMDeploymentTypeDetectionClause to get an existing detection clause from another application.

Parameter properties

Type:

DetectionClause[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddDetectionClauses

Parameter sets

ByAppIdDetectionClause
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppNameDetectionClause
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueDetectionClause
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AddLanguage

Specify an array of language tags that the deployment type supports. For example, to add Russian (Russia), specify the tag ru-RU.

For more information and a list of language tags, see Windows Language Code Identifier (LCID) Reference.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddLanguages, Languages, Language

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AddRequirement

Specify an array of requirement objects for the deployment type. To create a requirement rule object, use one of the following cmdlets:

Starting in version 2111, you can use the Get-CMDeploymentTypeRequirement cmdlet to copy rules from another deployment type.

Parameter properties

Type:

Rule[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationId

Specify the ID of the application for this deployment type.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAppId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdDetectionClause
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdScript
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ApplicationName

Specify the name of the application for this deployment type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAppNameScript
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppNameDetectionClause
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CacheContent

Set this parameter to $true to save content indefinitely in the client cache.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PersistContentInClientCache

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Comment

Specify an optional description for the deployment type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AdministratorComment

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentFallback

If you set this parameter to $true, when the content isn't available on any distribution points in the client's current or neighbor boundary groups, the client can use distribution points in the site default boundary group.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EnableContentLocationFallback, AllowClientsToUseFallbackSourceLocationForContent

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentLocation

Specifies the network source path of the content. The site system server requires permission to read the content files.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:InstallationFileLocation

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentTypeName

Specify a display name for this deployment type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DetectionClauseConnector

When you use the GroupDetectionClauses parameter to group detection clauses, use this parameter to specify the connector.

The following example defines the OR connector: @{"LogicalName"=$clauseFile3.Setting.LogicalName;"Connector"="OR"}

Parameter properties

Type:

Hashtable[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:DetectionClauseConnectors

Parameter sets

ByAppIdDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppNameDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableBranchCache

This parameter is deprecated. BranchCache is always enabled on clients, and they use it if the distribution point supports it.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AllowClientsToShareContentOnSameSubnet

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EstimatedRuntimeMins

Specify the estimated installation time, in minutes, of this deployment type for the application. Software Center displays this estimate to the user before the application installs.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EstimatedInstallationTimeMinutes, EstimatedInstallationTimeMins, EstimatedRunTimeMinutes

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ForceForUnknownPublisher

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force32Bit

Set this parameter to $true to run the install and uninstall programs as 32-bit processes on 64-bit clients.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Force32BitInstaller

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceScriptDetection32Bit

If you use a custom script to detect the presence of this deployment type, set this parameter to $true to run the script as a 32-bit process on 64-bit clients.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Force32BitDetectionScript

Parameter sets

ByAppNameScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GroupDetectionClauses

When you configure rules to detect the presence of this deployment type, use this parameter to group clauses. To create a detection clause, use one of the following cmdlets:

Save the output of these cmdlets into a variable. Then use the following format to group clauses: $clause2.Setting.LogicalName, $clause3.Setting.LogicalName.

Tip

In the Configuration Manager console, when you select the Group action, the clauses show parentheses before and after the grouped clauses.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:GroupDetectionClausesByLogicalName

Parameter sets

ByAppIdDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppNameDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueDetectionClause
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify an application object to configure. To get this object, use the Get-CMApplication cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Application

Parameter sets

ByAppValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueDetectionClause
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueScript
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InstallationBehaviorType

Specify the installation behavior for this deployment type:

  • InstallForUser: The client only installs the application for the user to whom you deploy the application.
  • InstallForSystem: The client installs the application only once. It's available to all users.
  • InstallForSystemIfResourceIsDeviceOtherwiseInstallForUser: If you deploy the application to a device, the client installs it for all users. If you deploy the application to a user, the client only installs it for that user.

Parameter properties

Type:InstallationBehaviorType
Default value:None
Accepted values:InstallForUser, InstallForSystem, InstallForSystemIfResourceIsDeviceOtherwiseInstallForUser
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InstallCommand

Specify the installation program command line to install this application.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:InstallationProgram

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InstallWorkingDirectory

Specify the path to use as the working directory when the client runs the InstallCommand.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:InstallationStartIn, InstallFolder

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogonRequirementType

Specify the requirement for a signed-in user:

  • OnlyWhenNoUserLoggedOn: Only when no user is signed into Windows.

  • OnlyWhenUserLoggedOn: Only when a user is signed in. This option is the default.

  • WhetherOrNotUserLoggedOn: Whether or not a user is signed in.

    Note

    The value WhereOrNotUserLoggedOn is deprecated. It's replaced by WhetherOrNotUserLoggedOn.

If you set InstallationBehaviorType to InstallForUser, then you can't set this parameter.

Parameter properties

Type:LogonRequirementType
Default value:None
Accepted values:OnlyWhenUserLoggedOn, WhereOrNotUserLoggedOn, WhetherOrNotUserLoggedOn, OnlyWhenNoUserLoggedOn
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaximumRuntimeMins

Specify the maximum allowed run time of the deployment program for this application. Set an integer value in minutes.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MaximumAllowedRunTimeMinutes, MaximumAllowedRunTimeMins, MaximumRunTimeMinutes

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProductCode

If the application uses Windows Installer technology, specify an MSI product code to set as the detection method. When you use this parameter, it overwrites any other detection methods.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAppId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RebootBehavior

Specify the post-installation behavior:

  • BasedOnExitCode: Determine behavior based on return codes.

  • NoAction: No specific action.

  • ProgramReboot: The software install program might force a device restart.

  • ForceReboot: Configuration Manager client will force a mandatory device restart.

For more information on these behaviors, see Create applications in Configuration Manager.

Parameter properties

Type:PostExecutionBehavior
Default value:None
Accepted values:BasedOnExitCode, NoAction, ForceReboot, ProgramReboot
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveLanguage

Specify an array of supported languages to remove from this deployment type.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveLanguages

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveRequirement

Specify an array of requirement rules to remove from this deployment type.

Parameter properties

Type:

Rule[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveRequirements

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RepairCommand

Use this parameter to configure the repair command. Also configure the RepairWorkingDirectory parameter.

Starting in version 2006, you can specify an empty string.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RepairProgram

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RepairWorkingDirectory

Use this parameter to configure the repair command's working directory. Also configure the RepairCommand parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RepairStartIn, RepairFolder

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequireUserInteraction

Set this parameter to $true to allow users to view and interact with the deployment type installation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RequiresUserInteraction

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScriptFile

Specify the script file to use to detect this deployment type. Also use the ScriptLanguage parameter.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByAppNameScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScriptLanguage

If you use the ScriptFile or ScriptText parameters, use this parameter to specify the script language.

Parameter properties

Type:ScriptLanguage
Default value:None
Accepted values:PowerShell, VBScript, JavaScript
Supports wildcards:False
DontShow:False
Aliases:ScriptType

Parameter sets

ByAppNameScript
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdScript
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueScript
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScriptText

Specify the text of a script to detect this deployment type. Also use the ScriptLanguage parameter.

For more information, see About custom script detection methods.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ScriptContent

Parameter sets

ByAppNameScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppIdScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValueScript
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SlowNetworkDeploymentMode

When a client uses a distribution point from a neighbor boundary group or the default site boundary group, specify the deployment option:

  • DoNothing: Don't download content
  • Download: Download content from the distribution point and run locally

Parameter properties

Type:ContentHandlingMode
Default value:None
Accepted values:DoNothing, Download
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceUpdateProductCode

If the application uses Windows Installer technology, specify an MSI product code. This product code is a GUID format.

Windows Source management enables an .MSI represented by this deployment type to automatically be updated or repaired from content source files on an available distribution point.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UninstallCommand

Specifies the command line to uninstall the application.

Starting in version 2006, you can specify an empty string.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UninstallationProgram

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UninstallContentLocation

Specify the network path to source content to use with the UninstallCommand that's different from the ContentLocation. Use this parameter when you set UninstallOption to Different.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UninstallOption

Specify what content to use with the UninstallCommand:

  • SameAsInstall: The install and uninstall content are the same. This option is the default.
  • NoneRequired: The application doesn't need content for uninstall.
  • Different: The uninstall content is different from the install content. Use UninstallContentLocation to specify the network path to the content that's used to uninstall the application.

Parameter properties

Type:UninstallContentSetting
Default value:None
Accepted values:SameAsInstall, NoneRequired, Different
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UninstallWorkingDirectory

Specify the path to use as the working directory when the client runs the UninstallCommand.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UninstallationStartIn, UninstallFolder

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserInteractionMode

Specify the installation program visibility:

  • Normal: The deployment type runs in the normal mode based on system and program defaults. This mode is the default.
  • Minimized: The deployment type runs minimized on client devices. Users might see the installation activity in the notification area or taskbar.
  • Maximized: The deployment type runs maximized on client devices. Users see all installation activity.
  • Hidden: The deployment type runs hidden on client devices. Users see no installation activity.

Parameter properties

Type:UserInteractionMode
Default value:None
Accepted values:Normal, Minimized, Maximized, Hidden
Supports wildcards:False
DontShow:False
Aliases:InstallationProgramVisibility

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object