Set-SCSPFExtensibleEventHandler
Sets an extensible event handler in Service Provider Foundation.
Syntax
Set-SCSPFExtensibleEventHandler
-EventName <String>
[-OrchestratorUri <String>]
[-RunbookPath <String>]
[-Enable]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-SCSPFExtensibleEventHandler cmdlet invokes a runbook in System Center - Orchestrator to run whenever a new virtual machine or new service is created. The virtual machine or service must be created by calls to Service Provider Foundation with the Virtual Machine Manager (VMM) service. Service Provider Foundation raises internal events to invoke the runbook, and the runbook will be invoked continuously as long as the extensible event handler is enabled.
Service Provider Foundation will not invoke the runbook if the virtual machine or service was created by other means, such as by using PowerShell cmdlets for by using the console in VMM.
To support the infrastructure for invoking a runbook, Service Provider Foundation calls the Start-SCOrchestratorRunbook cmdlet internally; the user does not need to call it explicitly.
Examples
Example 1: Set an event handler
PS C:\>Set-SCSPFExtensibleEventHandler -EventName "VirtualMachineCreated" -OrchestratorUri "https://scxspf-ws8-24:82/Orchestrator2012/Orchestrator.svc" -RunbookPath "\SPF Runbooks\Extensibility\VM Created" -EnableThis command enables an event handler to invoke a runbook.
Example 2: Disable an event handler
PS C:\>Set-SCSPFExtensibleEventHandler -EventName "VirtualMachineCreated" -OrchestratorUri "https://scxspf-ws8-24:82/Orchestrator2012/Orchestrator.svc" -RunbookPath "\SPF Runbooks\Extensibility\VM Created"This command disables an event handler from invoking a runbook because the Enable parameter is omitted.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Enable
Indicates that the extensible event handler is enabled. Omit this parameter to disable the handler.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EventName
Specifies either VirtualMachineCreated or ServiceCreated for the event that invokes an Orchestrator runbook.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OrchestratorUri
Specifies the URI of the Orchestrator web service as specified by the web.config file in C:\Program Files (x86)\Microsoft System Center 2012\Orchestrator\Orchestration Console.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunbookPath
Specifies the path to a runbook in Orchestrator.
| Type: | System.String |
| 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 is not run.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
System.Object