Set-CCMDeploymentStep

Modify a Deployment Step of a Central Management Deployment

Syntax

Set-CCMDeploymentStep `
  -Deployment <String> `
  -Step <String> `
  [-TargetGroup <String[]>] `
  [-ExecutionTimeoutSeconds <String>] `
  [-FailOnError] `
  [-RequireSuccessOnAllComputers] `
  [-ValidExitCodes <String[]>] [<CommonParameters>]

Set-CCMDeploymentStep `
  -Deployment <String> `
  -Step <String> `
  [-TargetGroup <String[]>] `
  [-ExecutionTimeoutSeconds <String>] `
  [-FailOnError] `
  [-RequireSuccessOnAllComputers] `
  [-ValidExitCodes <String[]>] `
  -ChocoCommand <String> `
  -PackageName <String> [<CommonParameters>]

Set-CCMDeploymentStep `
  -Deployment <String> `
  -Step <String> `
  [-TargetGroup <String[]>] `
  [-ExecutionTimeoutSeconds <String>] `
  [-FailOnError] `
  [-RequireSuccessOnAllComputers] `
  [-ValidExitCodes <String[]>] `
  -Script <ScriptBlock> [<CommonParameters>]

Description

Modify a Deployment Step of a Central Management Deployment

Aliases

None

Examples

EXAMPLE 1

Set-CCMDeploymentStep -Deployment 'Google Chrome Upgrade' -Step 'Upgrade' -TargetGroup LabPCs -ExecutionTimeoutSeconds 14400 -ChocoCommand Upgrade -PackageName googlechrome

EXAMPLE 2

$stepParams = @{
    Deployment = 'OS Version'
    Step = 'Gather Info'
    TargetGroup = 'US-East servers'
    Script = { $data = Get-WMIObject win32_OperatingSystem
                [pscustomobject]@{
                    Name = $data.caption
                    Version = $data.version
                }
    }
}
Set-CCMDeploymentStep @stepParams

Inputs

None

Outputs

None

Parameters

-Deployment <String>

The Deployment to modify

Property	Value
Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	false

-Step <String>

The step to modify

Property	Value
Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	false

-TargetGroup [<String[]>]

Set the target group of the deployment

Property	Value
Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false

-ExecutionTimeoutSeconds [<String>]

Modify the execution timeout of the deployment in seconds

Property	Value
Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false

-FailOnError

Set the FailOnError flag for the deployment step

Property	Value
Aliases
Required?	false
Position?	named
Default Value	False
Accept Pipeline Input?	false

-RequireSuccessOnAllComputers

Set the RequreSuccessOnAllComputers for the deployment step

Property	Value
Aliases
Required?	false
Position?	named
Default Value	False
Accept Pipeline Input?	false

-ValidExitCodes [<String[]>]

Set valid exit codes for the deployment

Property	Value
Aliases
Required?	false
Position?	named
Default Value
Accept Pipeline Input?	false

-ChocoCommand <String>

For a basic step, set the choco command to execute. Install, Upgrade, or Uninstall

Property	Value
Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	false

-PackageName <String>

For a basic step, the choco package to use in the deployment

Property	Value
Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	false

-Script <ScriptBlock>

For an advanced step, this is a script block of PowerShell code to execute in the step

Property	Value
Aliases
Required?	true
Position?	named
Default Value
Accept Pipeline Input?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters https://go.microsoft.com/fwlink/p/?LinkID=113216 .

Function Reference

NOTE

This documentation has been automatically generated from Import-Module "ChocoCCM" -Force; Get-Help Set-CCMDeploymentStep -Full.