Add-SCServicingWindowSubscription
Add-SCServicingWindowSubscription
Adds a servicing window to a virtual machine, host, or service.
Syntax
Parameter Set: Host
Add-SCServicingWindowSubscription [-ServicingWindow] <ServicingWindow> -VMHost <Host> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: Service
Add-SCServicingWindowSubscription [-ServicingWindow] <ServicingWindow> -Service <Service> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: VM
Add-SCServicingWindowSubscription [-ServicingWindow] <ServicingWindow> -VM <VM> [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed 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.
Parameters
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Service<Service>
Specifies a VMM service object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ServicingWindow<ServicingWindow>
Specifies a servicing window object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VM>
Specifies a virtual machine object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMHost<Host>
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.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
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).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- ServicingWindowSubscription
Examples
1: Subscribe all virtual machines owned by a specific user to a servicing window.
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.
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
2: Subscribe all virtual machines owned by a specific user to a servicing window using the pipeline operator.
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.
PS C:\> $SvcWindow = Get-SCServicingWindow -Name "Test Servers Group 3"
PS C:\> Get-SCVirtualMachine | where {$_.Owner -eq "Contoso\NevenSokec"} | Add-SCServicingWindowSubscription -ServicingWindow $SvcWindow