Share via

Start-SCOrchestratorRunbook

Module:
spfadmin Module

Starts a runbook in Service Provider Foundation.

Syntax

Default (Default) 

Start-SCOrchestratorRunbook
    -Uri <String>
    -RunbookPath <String>
    [-RunbookParameters <Hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Start-SCOrchestratorRunbook cmdlet invokes the runbook as specified by the RunbookPath parameter in the Set-SCSPFExtensibleEventHandler cmdlet. Administrators do not need to perform this; Service Provider Foundation performs it automatically.

This cmdlet is for internal use only.

Examples

1:

PS C:\># The Start-SCOrchestratorRunbook cmdlet is for internal use only.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunbookParameters

Specifies the parameters for a runbook in Service Provider Foundation.

Parameter properties

Type:System.Collections.Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RunbookPath

Specifies the path to a runbook in Service Provider Foundation.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Uri

Specifies the uniform resource identifier (URI) of the runbook in Service Provider Foundation.

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object