deleteTopology

A Workflow Engine function that attempts to delete the named topology. 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.Workflow Engine Functions Reference

Arguments

Workflow Engine function deleteTopology 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 deleteTopology.

If you want to delete the topology stored in the "myTopology" key of the workflow context, set the following:

  • topologyName: workflowContext.myTopology

The UI translates your settings to the following JSON:

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

For an alert with the following workflowContext.myTopology = "my network", the action deletes the topology.