Add-SCServicingWindowSubscription

Adds a servicing window to a virtual machine, host, or service.

Description

The Add-SCServicingWindowSubscription cmdlet adds a servicing window to a virtual machine, host, or service. After a servicing window is assigned to an object, users can schedule maintenance work to be done within the servicing window by using a third-party scheduling system.

For more information about Add-SCServicingWindowSubscription, type: "Get-Help Add-SCServicingWindowSubscription -online".

Parameters

ServicingWindow

Required? true
Accept Pipeline Input? false
Position? 0 
Specifies a servicing window object.

VMHost

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts. 

For more information about each type of host, type: "Get-Help Add-SCVMHost -detailed". See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

ServicingWindow

Required? true
Accept Pipeline Input? false
Position? 0 
Specifies a servicing window object.

Service

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM service object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

ServicingWindow

Required? true
Accept Pipeline Input? false
Position? 0 
Specifies a servicing window object.

VM

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a virtual machine object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Examples

1: Subscribe all virtual machines owned by a specific user to a servicing window. 
PS C:\> $SvcWindow = Get-SCServicingWindow -Name "Backup Staging A"
PS C:\> $VMs = Get-SCVirtualMachine | where {$_.Owner -eq "Contoso\ReneeLo"} 
PS C:\> Add-SCServicingWindowSubscription -ServicingWindow $SvcWindow -VM $VMs


The first command gets the servicing window object named Backup Staging A and stores the object in the $SvcWindow variable.

The second command gets all virtual machine objects, selects only the virtual machines that are owned by Contoso\ReneeLo. and then stores those objects in the $VMs variable.

The last command subscribes the virtual machines stored in $VMs to the servicing window stored in $SvcWindow.
2: Subscribe all virtual machines owned by a specific user to a servicing window using the pipeline operator. 
PS C:\> $SvcWindow = Get-SCServicingWindow -Name "Test Servers Group 3"
PS C:\> Get-SCVirtualMachine | where {$_.Owner -eq "Contoso\NevenSokec"} | Add-SCServicingWindowSubscription -ServicingWindow $SvcWindow

The first command gets the servicing window object named Test Servers Group 3 and stores the object in the $SvcWindow variable.

The second command gets all virtual machine objects, selects only the virtual machines that are owned by Contoso\ReneeLo and then uses the pipeline operator to pass the virtual machines to the Add-SCServicingWindowSubscription cmdlet. Add-SCServicingWindowSubscription subscribes each virtual machine that is passed to it to the servicing window stored in $SvcWindow.

See Also