Chat now with support
Chat with Support

Foglight Automation 7.1.0 - User and Reference Guide

Pre-installed ActionPacks

This section provides an overview of the ActionPacks that are included by default with the Foglight for Automation.

•
ActionPack for E-mail Processing
•
Get E-mails Action
•
New E-mail Action
•
ActionPack for Workflow Control
•
Workflow Failure Action
•
Workflow Success Action
•
Run Workflow Action
•
Linked Workflow Action
•
ActionPack for Resource Locking
ActionPack for E-mail Processing

This ActionPack enables sending (New E-mail Action) and receiving (Get E-mails Action) e-mail messages.

New E-mail Action

This action creates and sends a new e-mail message.

Pre-conditions:
•
E-mail processing setup must be completed. Navigate to Configuration > Settings and specify the From E-mail Address, SMTP Host, SMTP Port, SMTP User Name, SMTP Password parameters.
 
Table 1. New E-mail Action Input Parameters
Name
Type
Description

To

String

E-mail address

Subject

String

Subject of the e-mail

Body

String

Body of the e-mail

Get E-mails Action

This action logs in to a remote POP3 server and retrieves a given number (limit) of e-mail messages.

Pre-conditions:
•
None
 
Table 2. Get E-mails Action Input Parameters
Name
Type
Description

Host

String

IP address of POP3 host.

username

String

Username

password

String

Password

waitForMessages

Boolean

Flag that causes the action to wait for a message.

deleteReceived

Boolean

If true, the method will delete received messages on server.

limit

Integer

Expected number of received e-mails.

 
Table 3. Get E-mails Action Output Parameters
Name
Type
Description

from

String

E-mail’s “From” text

subject

String

E-mail’s “Subject” text

Body

String

E-mail’s “Body” text

receivedCount

Integer

Number of received e-mails

leftCount

Integer

Number of e-mails remaining in the mailbox

ActionPack for Workflow Control

This ActionPack contains actions for workflow construction, and actions to manage workflow execution.

•
Workflow Failure Action
•
Workflow Success Action
•
Run Workflow Action
•
Linked Workflow Action
•
Sleep Action
Workflow Failure Action

This action finishes workflow execution with the “Failed” state. The Workflow Failure action does not have input or output parameters.

Workflow Success Action

This action finishes workflow execution with the “Succeeded” state. The Workflow Success action does not have input or output parameters.

Run Workflow Action

This action launches the specified workflow, passing the input parameters in a JSON string. Output parameters are not supported.

Pre-conditions:
•
The passed workflow parameters must be in a JSON string
 
Table 4. Run Workflow ActionInput Parameters
Name
Type
Description

Workflow GUID

String

Globally Unique Identifier (GUID) of the workflow.

Workflow parameters

String

Target workflow parameters. This string should contain a JSON representation of mappings for the target workflow parameters.

 
* 
NOTE: If the actual parameter string is built inside some workflow action (and does not come from a global parameter), it must not contain any references to other actions. This is due to the workflow engine limitation.

The string should be (preferably) enveloped in {}; all the text after the last “}” is ignored.

It is possible to use Resource references when providing workflow parameter mappings.

Example:

{ GP_1: "test", VM: "action2.VM", test: ["1", "2", "3"], VM2: "GP.VM",
"VM3": "ou=554958AD25D2A7A70663B682C438DBD4,
ou=01D094B466F17C46642697364186E9B4,
ou=307BE766E09F05EDD43C81C8CF4CD4B6,ou=172.16.41.16,
ou=Discovered VMware Infrastructure,ou=vfabrix,dc=vfi,dc=local" }
Linked Workflow Action

This action allows to create linked workflows. In other words, you can create a workflow that launches another workflow.

How To Use

After you have added the Linked Workflow action to the Workspace and linked it to other action(s), do the following:

1
Click Click to set a workflow on the Linked Workflow action. The Select workflow dialog box opens with a list of available workflows.
2
Select theworkflow that you want to link. Click OK.
3
Click the link that leads to the Linked Workflow action. The Links pane lists input parameters for the linked workflow.
4
Type in the input parameters of the linked workflow.
Sleep Action

This action pauses the workflow execution for the specified number of seconds.

Pre-conditions:
•
None
 
Table 5. Sleep Action Input Parameters
Name
Type
Description

Pause for

Long integer

Time in seconds, during which the workflow will be paused

ActionPack for Resource Locking

This ActionPack provides the ability to lock resources (hosts, virtual machines, snapshots, and so on) so that other actions cannot update, delete, or move those locked resources.

Lock Action

This action tries to obtain a lock for a resource (waits infinitely).

Pre-conditions:
•
None
 
Table 6. Lock Action Input Parameters
Name
Type
Description

resource

vfiTop resource

Resource to be locked

 
Table 7. Lock Action Output Parameters
Name
Type
Description

lockId

Long

Lock ID

Lock with Timeout Action

This action tries to obtain a lock for a resource for the specified time limit.

Pre-conditions:
•
None
 
Table 8. Lock with Timeout Action Input Parameters
Name
Type
Description

resource

vfiTop resource

Resource to be locked

timeout

Long

Amount of time in seconds during which the action will try to obtain a lock

 
Table 9. Lock with Timeout Action Output Parameters
Name
Type
Description

lockId

Long

Lock ID

Try To Lock Action

This action makes a single attempt to obtain a lock on the named resource.

Pre-conditions:
•
None
 
Table 10. Try to Lock Action Input Parameters
Name
Type
Description

resource

vfiTop resource

Resource to be locked

 
Table 11. Try to Lock Action Output Parameters
Name
Type
Description

lockId

Long

Lock ID

Unlock Action

This action unlocks a resource lock.

Pre-conditions:
•
None
 
Table 12. Unlock Action Input Parameters
Name
Type
Description

lockId

Long

Lock identifier. You can take it from the output parameter of a lock action

Unlock All Action

This action unlocks all current workflow locks. Linked workflow locks are not processed. This action does not have input or output parameters.

Unlock Resource Action

This action looks for a lock that corresponds to the specified resource and unlocks it.

Pre-conditions:
•
None
 
Table 13. Unlock Resource Action Input Parameters
Name
Type
Description

resource

vfiTop resource

Resource to be unlocked

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating