Invoke-CMOrchestrationGroup
Start orchestration on an orchestration group.
Syntax
Invoke-CMOrchestrationGroup
-Id <Int32>
[-IgnoreServiceWindow <Boolean>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMOrchestrationGroup
-InputObject <IResultObject>
[-IgnoreServiceWindow <Boolean>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMOrchestrationGroup
-Name <String>
[-IgnoreServiceWindow <Boolean>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Use this cmdlet to start orchestration on an orchestration group.
For more information, see Start orchestration.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1
This example first gets an object for the orchestration group named IT servers. It then passes that object through the pipeline to the Invoke-CMOrchestrationGroup cmdlet. It immediately starts the installation and bypasses any maintenance windows.
Get-CMOrchestrationGroup -Name "IT servers" | Invoke-CMOrchestrationGroup -IgnoreServiceWindow $trueParameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specify the ID of orchestration group to start. This value is the MOGID property, which is an integer. For example, 16777217.
| Type: | Int32 |
| Aliases: | MOGId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IgnoreServiceWindow
Set this parameter to $true to start the installation immediately and bypass maintenance windows.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specify an object for the orchestration group to start. To get this object, use the Get-CMOrchestrationGroup cmdlet.
| Type: | IResultObject |
| Aliases: | OrchestrationGroup |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specify the name of the orchestration group to start.
| Type: | String |
| Aliases: | OrchestrationGroupName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object