Ansible modules for managing Stingray Traffic Manager
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
__init__.py
steelapp_node.py
steelapp_pool.py

README.md

ansible-steelapp

These are ansible modules made for managing the SteelApp Traffic Manager.

Currently, it is using the REST API v. 3.0. No other API versions are supported.

Presently, the following modules are available:

  • steelapp_node - for managing nodes in pools
  • steelapp_pool - for managing pool configurations

Module: steelapp_node

Manages a node and it's properties.

Complete example:

- hosts: all
  connection: local
  gather_facts: False
  tasks:
    - name: add node to pool
      steelapp_node:
        name: mynode:80
        pool: mypool
        state: present
        lb_state: 'active'
        weight: 2
        priority: 1
        server: myserver.mydomain.com
        user: myuser
        password: mypassword
      register: pool

Fields

name (required)

Name of node to manage.

pool (required)

Name of pool to manage.

state

Desired state:

  • present: ensure the node exists
  • absent: ensure the node does not exist

Default: present

lb_state

State of node in pool:

  • active: enable the node (default for new nodes)
  • disabled: disable the node
  • draining: drain the node

The default for new nodes is 'active'.

weight

Set the weight of the node. Defaults to the server's default.

priority

Set the priority of the node. Defaults to the server's default.

server (required)

FQDN of steelapp server.

port

Port to connect to (default: 9070).

timeout

HTTP timeout (default: 3).

user

Name of user to authenticate as.

password

Password used for authentication.

Module: steelapp_pool

Manage a pool and it's properties

Complete example:

- hosts: all
  connection: local
  gather_facts: False
  tasks:
    - name: Add pool and set note property
      steelapp_pool:
        name: mypool
        state: present
        properties:
          basic:
            note: "This pool is cool."
        server: myserver.mydomain.com
        user: myuser
        password: mypassword
      register: pool

Fields

name (required)

Name of pool to manage.

state

Desired state:

  • present: ensure the pool exists
  • absent: ensure the pool does not exist

Default: present

properties

Hash of properties to set on the pool. See the REST API Documentation for more information about which properties can be set.

Properties are merged with the existing ones.

Please not that setting list values (such as properties->basic->nodes_table) will replace the current list with the one provided.

server (required)

FQDN of steelapp server.

port

Port to connect to (default: 9070).

timeout

HTTP timeout (default: 3).

user

Name of user to authenticate as.

password

Password used for authentication.