Set-SCSPFExtensibleEventHandler

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-SCSPFExtensibleEventHandler cmdlet invokes a runbook in System Center 2016 - 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.

Parameters

-Enable

Indicates that the extensible event handler is enabled. 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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OrchestratorUri<String>

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.


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 Orchestrator.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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

Example 1: Set an event handler

This command enables an 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

Example 2: Disable an event handler

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


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

Related topics

Community Additions

ADD
Show: