Networks

syntropynet.syntropy.syntropy_network

Configures Syntropy Networks using Network Configuration embedded in the playbook.

Parameter Choices/Defaults Comments
api_token
string
API Authorization token string.
This parameter is required if SYNTROPY_API_TOKEN environment variable is not set.
api_url
string
URL Of the Platform API.
This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
connections
dictionary / required
A dictionary specifying network connections. A key represents the name of the endpoint or tag name of a set of endpoints.
Each endpoint has a mandatory option 'type' which is one of 'endpoint' or 'tag' and a 'state' option that is one of 'present' or 'absent'.
For p2p or p2m networks a connections supports 'connect_to' option which is a dictionary containing endpoint names/tags as keys.
state
string
    Choices:
  • present ←
  • absent
A desired state of the API key.
topology
string / required
    Choices:
  • p2p
  • p2m
  • mesh
Network topology.

Example

- name: Create a Point to point network
      syntropy_network:
        name: p2p-network
        topology: p2p
        state: present
        connections:
          endpoint-1:
            state: present
            connect_to:
              endpoint-2
          endpoint-3:
            state: present
            connect_to:
              endpoint-4
    - name: Create a Point to multi-point network
      syntropy_network:
        name: p2m-network
        topology: p2m
        state: present
        connections:
          endpoint-1:
            state: present
            type: endpoint
            connect_to:
              iot-devices:
                type: tag
                state: present
    - name: Create a mesh network
      syntropy_network:
        name: mesh-network
        topology: mesh
        state: present
        connections:
          dns-servers:
            state: present
            type: tag

Did this page help you?