syntropynet.syntropy.syntropy_template (0.3.0) — module

Install collection

Install with ansible-galaxy collection install syntropynet.syntropy:==0.3.0

Add to requirements.yml

  collections:
    - name: syntropynet.syntropy
      version: 0.3.0

Description

Allows to create/delete networks between endpoints using Jinja configuration template.

Configuration file format can be either YAML or JSON and templating is done using Jinja language.

Requirements

• syntropynac
• jinja2

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

-   name: Create a Point to point network
    syntropy_template:
        template_path: "files/configuration.yaml"
        template_params:
            network_name: "custom name"
            network_state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

-   name: Delete the network
    syntropy_template:
        template_path: "files/configuration.yaml"
        template_params:
            network_name: "custom name"
            network_state: absent

Inputs

    
api_url:
    default: null
    description:
    - URL Of the Platform API.
    - This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
    required: false
    type: str

api_token:
    default: null
    description:
    - API Authorization token string.
    - This parameter is required if SYNTROPY_API_TOKEN environment variable is not set.
    required: false
    type: str

template_path:
    description:
    - The local path of the Syntropy configuration template.
    - This must be the full path to the file, relative to the working directory. If using
      roles this may look
    - like C(roles/syntropy/files/config-example.yaml).
    required: true
    type: path

template_params:
    default: {}
    description: ID of the network. Has precedence before network name.
    required: false
    type: dict

Outputs

error:
  description: Error message upon unsuccessful configuration.
  returned: always
  sample: Syntropy API call resulted in an error
  type: str