activateTopology

A Workflow Engine function that updates a named topology from an inactive to an active state. Returns false if the topology can not be activated.

This function is available for alert workflows.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

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

If you want to activate an inactive topology named "my network", set the following:

  • topologyName: my network

The UI translates your settings to the following JSON:

{"topologyName":"my network"}

If you run the topologies API, you can see your new topology:

curl -X GET 'https://example.com/api/v1/topologies'

Returns the following:

 {  
    "name": "my network",
    "active": true,
    "description": "my network nodes"
 }