Skip to main content

checkTopology

A Workflow Engine function that checks for the existence of a named topology. Returns true if the topology exists.

The topology name can be static or a substitution value. To substitute a value, use $(<attribute_name>). For example $(custom_info.myTopology).

This function is available for alert workflows.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function checkTopology takes the following arguments:

Name

Required

Type

Description

topologyName

yes

string

The name or substited value for the topology. To substitute a value, use $(<attribute_name>). For example $(custom_info.myTopology)

Example

The following example demonstrates typical use of Workflow Engine function checkTopology.

If you want to delete the topology stored in custom_info.moog_topology set the following:

  • topologyName: $(custom_info.myTopology)

The UI translates your settings to the following JSON:

{"topologyName":"$(custom_info.myTopology)"}

For an alert with the following custom_info.myTopology = "my network", the action returns true if the "my network" topology exists.