Skip to content

Invoke-CEPWorkflow

Synopsis

Invoke a VMware Aria Automation Orchestrator workflow

Syntax

A (Default)

Invoke-CEPWorkflow -id <String> [-parameterName <String>] [-parameterValue <String>] [-parameterType <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

B

Invoke-CEPWorkflow -id <String> [-parameters <PSObject[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

C

Invoke-CEPWorkflow [-parameterName <String>] [-parameterValue <String>] [-parameterType <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

D

Invoke-CEPWorkflow [-parameters <PSObject[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

The Invoke-CEPWorkflow cmdlet starts a VMware Aria Automation Orchestrator workflow.

Examples

Example 1

Invoke-CEPWorkflow -ID 3f23f186-158a-4869-b464-b7271fc216ba

Example 2

Invoke-CEPWorkflow -ID 3f23f186-158a-4869-b464-b7271fc216ba -parameterName 'text' -parameterValue 'foo' -parameterType 'string'

Example 3

$Parameters =  @"
{"parameters":
    [
        {
            "value": {"string":{ "value": "bar"}},
            "type": "string",
            "name": "foo",
            "scope": "local"
        },
        {
            "value": {"number":{ "value": 2022}},
            "type": "number",
            "name": "year",
            "scope": "local"
        }
    ]
}
"@

Invoke-CEPWorkflow -id 3f23f186-158a-4869-b464-b7271fc216ba -parameters ($parameters | ConvertFrom-Json).parameters

Example 4

$param1 = New-vROParameterDefinition -name 'foo' -value 'bar' -type string -scope LOCAL
Invoke-CEPWorkflow -id 3f23f186-158a-4869-b464-b7271fc216ba -parameters $param1

Example 5

Invoke-CEPWorkflow -name 'Import a trusted certificate from a file' | Invoke-CEPWorkflow -parameterName 'foo' -parameterValue 'bar' -parameterType string

Parameters

-id

The VMware Aria Automation Orchestrator workflow ID.

Type: String
Parameter Sets: A
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: String
Parameter Sets: B
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-parameterName

The VMware Aria Automation Orchestrator workflow parameter name.

Type: String
Parameter Sets: A, C
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-parameterValue

The VMware Aria Automation Orchestrator workflow parameter value.

Type: String
Parameter Sets: A, C
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-parameterType

The VMware Aria Automation Orchestrator workflow parameter type.

Type: String
Parameter Sets: A, C
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-parameters

The VMware Aria Automation Orchestrator workflow parameters.

Type: PSObject[]
Parameter Sets: B, D
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Progress Action

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters

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