deleteTopologyLink

A Workflow Engine function that removes a direct link between two endpoints, A (source node) and Z (sink node), in a named topology. Both nodes must exist with a direct link to return true.

This function is available for alert workflows.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

Workflow Engine function deleteTopologyLink 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)

sourceNode

yes

string

The name or substituted value for the 'A' endpoint (source node). To substitute a value, use $(&lt;attribute_name&gt;). For example $(custom_info.mySourceNode)

sinkNode

yes

string

The name or substituted value for the 'Z' endpoint (sink node). To substitute a value, use $(&lt;attribute_name&gt;). For example $(custom_info.mySinkNode)

Example

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

If you want to remove a link in the topology "my network" between the alert source and another node you have previously added to the workflow context, set the following:

  • topologyName: my network

  • sourceNode: $(source)

  • sinkNode: $(workflowContext.destination)

The UI translates your settings to the following JSON:

{"topologyName":"my network",
"sourceNode":"$(source)","sinkNode":"$(workflowContext.destination)"}

For an alert where source = sflinux101 and the corresponding workflowContext.destination = sflinux102, the workflow action deletes any existing direct link between the two nodes.