Set-SCSPFExtensibleEventHandler

Article
10/29/2013

Applies To: System Center 2012 R2 Orchestrator

Set-SCSPFExtensibleEventHandler

Sets an extensible event handler in Service Provider Foundation.

Syntax

Parameter Set: Default
Set-SCSPFExtensibleEventHandler -EventName <String> [-Enable] [-OrchestratorUri <String> ] [-RunbookPath <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SCSPFExtensibleEvent cmdlet invokes a runbook in System Center 2012 - Orchestrator to be 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 VMM Service. Service Provider Foundation raises internal events to invoke the runbook and the runbook will continue to 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 Windows PowerShell cmdlets or by using the console in System Center 2012 – Virtual Machine Manager (VMM).

To support the infrastructure for invoking a runbook, Service Provider Foundation calls the Start-SCOrchestratorRunbook cmdlet internally and it does to need to be explicitly called by the user.

Parameters

-Enable

Enables the extensible event handler. Specify this parameter by itself to enable the handler. There is no associated value. Omit this parameter to disable the handler.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EventName<String>

Specifies either VirtualMachineCreated or ServiceCreated for the event that invokes an Orchestrator runbook. These are the only permitted values for this parameter.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-OrchestratorUri<String>

Specifies the URI to the Orchestrator web service as specified in the web.config file at C:\Program Files (x86)\Microsoft System Center 2012\Orchestrator\Orchestration Console.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunbookPath<String>

Specifies the path to a runbook in System Center 2012 - Orchestrator.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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.

Examples

1: Set an event handler.

This command enables the event handler to invoke a Runbook.

PS C:\> Set-SCSPFExtensibleEventHandler -EventName "VirtualMachineCreated" -OrchestratorUri "https://scxspf-ws8-24:82/Orchestrator2012/Orchestrator.svc" -RunbookPath "\SPF Runbooks\Extensibility\VM Created" -Enable

2: Disable an event handler.

This command disables the event handler from invoking a runbook because the Enable parameter is omitted.

PS C:\> Set-SCSPFExtensibleEventHandler -EventName "VirtualMachineCreated" -OrchestratorUri "" -RunbookPath ""

Set-SCSPFExtensibleEventHandler