Invoke-St2Action

SYNOPSIS

Invoke (run) an action within a pack

SYNTAX

Invoke-St2Action [-Connection <St2ClientConnection>] -Parameters <Hashtable> -ActionName <String> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

Invoke-St2Action [-Connection <St2ClientConnection>] -Parameters <Hashtable> -Action <Action> [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

PARAMETERS

-Connection <St2ClientConnection>

The connection object (defaults to the one stored in the session)

Required?                    false
Position?                    named
Default value
Accept pipeline input?       true (ByPropertyName)
Accept wildcard characters?  false

-Parameters <Hashtable>

Collection of parameters for the given action, each a Key-value-pair with the variable and the value.

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-ActionName <String>

The name of the action to run, including the pack name

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-InformationAction <ActionPreference>

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-InformationVariable <String>

Required?                    false
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

-Action <Action>

The action object, from Get-St2Actions

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Accept wildcard characters?  false

INPUTS

OUTPUTS

NOTES

EXAMPLES

Run an action by name

Invoke-St2Action -ActionName "libcloud.list_vms" -Parameters @{"credentials"="my-aws"}

Run an action by reference

$action = Get-St2Actions -PackName "libcloud" -Name "list_vms"