mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Merge pull request #4054 from mhite/bigip_pool_member
New bigip_pool_member module
This commit is contained in:
jctanner
commit
de1e3f0cbc
1 changed files with 378 additions and 0 deletions
378
library/net_infrastructure/bigip_pool_member
Normal file
378
library/net_infrastructure/bigip_pool_member
Normal file
|
|
@ -0,0 +1,378 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2013, Matt Hite <mhite@hotmail.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: bigip_pool_member
|
||||
short_description: "Manages F5 BIG-IP LTM pool members"
|
||||
description:
|
||||
- "Manages F5 BIG-IP LTM pool members via iControl SOAP API"
|
||||
version_added: "1.3"
|
||||
author: Matt Hite
|
||||
notes:
|
||||
- "Requires BIG-IP software version >= 11"
|
||||
- "F5 developed module 'bigsuds' required (see http://devcentral.f5.com)"
|
||||
- "Best run as a local_action in your playbook"
|
||||
- "Supersedes bigip_pool for managing pool members"
|
||||
|
||||
requirements:
|
||||
- bigsuds
|
||||
options:
|
||||
server:
|
||||
description:
|
||||
- BIG-IP host
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
user:
|
||||
description:
|
||||
- BIG-IP username
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
password:
|
||||
description:
|
||||
- BIG-IP password
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
state:
|
||||
description:
|
||||
- Pool member state
|
||||
required: true
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
aliases: []
|
||||
pool:
|
||||
description:
|
||||
- Pool name. This pool must exist.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
partition:
|
||||
description:
|
||||
- Partition
|
||||
required: false
|
||||
default: 'Common'
|
||||
choices: []
|
||||
aliases: []
|
||||
host:
|
||||
description:
|
||||
- Pool member IP
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: ['address', 'name']
|
||||
port:
|
||||
description:
|
||||
- Pool member port
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
connection_limit:
|
||||
description:
|
||||
- Pool member connection limit. Setting this to 0 disables the limit.
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
description:
|
||||
description:
|
||||
- Pool member description
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
rate_limit:
|
||||
description:
|
||||
- Pool member rate limit (connections-per-second). Setting this to 0 disables the limit.
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
ratio:
|
||||
description:
|
||||
- Pool member ratio weight. Valid values range from 1 through 100. New pool members -- unless overriden with this value -- default to 1.
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
## playbook task examples:
|
||||
|
||||
---
|
||||
# file bigip-test.yml
|
||||
# ...
|
||||
- hosts: bigip-test
|
||||
tasks:
|
||||
- name: Add pool member
|
||||
local_action: >
|
||||
bigip_pool_member
|
||||
server=lb.mydomain.com
|
||||
user=admin
|
||||
password=mysecret
|
||||
state=present
|
||||
pool=matthite-pool
|
||||
partition=matthite
|
||||
host="{{ ansible_default_ipv4["address"] }}"
|
||||
port=80
|
||||
description="web server"
|
||||
connection_limit=100
|
||||
rate_limit=50
|
||||
ratio=2
|
||||
|
||||
- name: Modify pool member ratio and description
|
||||
local_action: >
|
||||
bigip_pool_member
|
||||
server=lb.mydomain.com
|
||||
user=admin
|
||||
password=mysecret
|
||||
state=present
|
||||
pool=matthite-pool
|
||||
partition=matthite
|
||||
host="{{ ansible_default_ipv4["address"] }}"
|
||||
port=80
|
||||
ratio=1
|
||||
description="nginx server"
|
||||
|
||||
- name: Remove pool member from pool
|
||||
local_action: >
|
||||
bigip_pool_member
|
||||
server=lb.mydomain.com
|
||||
user=admin
|
||||
password=mysecret
|
||||
state=absent
|
||||
pool=matthite-pool
|
||||
partition=matthite
|
||||
host="{{ ansible_default_ipv4["address"] }}"
|
||||
port=80
|
||||
|
||||
'''
|
||||
|
||||
try:
|
||||
import bigsuds
|
||||
except ImportError:
|
||||
bigsuds_found = False
|
||||
else:
|
||||
bigsuds_found = True
|
||||
|
||||
# ===========================================
|
||||
# bigip_pool_member module specific support methods.
|
||||
#
|
||||
|
||||
def bigip_api(bigip, user, password):
|
||||
api = bigsuds.BIGIP(hostname=bigip, username=user, password=password)
|
||||
return api
|
||||
|
||||
def pool_exists(api, pool):
|
||||
# hack to determine if pool exists
|
||||
result = False
|
||||
try:
|
||||
api.LocalLB.Pool.get_object_status(pool_names=[pool])
|
||||
result = True
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "was not found" in str(e):
|
||||
result = False
|
||||
else:
|
||||
# genuine exception
|
||||
raise
|
||||
return result
|
||||
|
||||
def member_exists(api, pool, address, port):
|
||||
# hack to determine if member exists
|
||||
result = False
|
||||
try:
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.get_member_object_status(pool_names=[pool],
|
||||
members=[members])
|
||||
result = True
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "was not found" in str(e):
|
||||
result = False
|
||||
else:
|
||||
# genuine exception
|
||||
raise
|
||||
return result
|
||||
|
||||
def delete_node_address(api, address):
|
||||
result = False
|
||||
try:
|
||||
api.LocalLB.NodeAddressV2.delete_node_address(nodes=[address])
|
||||
result = True
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "is referenced by a member of pool" in str(e):
|
||||
result = False
|
||||
else:
|
||||
# genuine exception
|
||||
raise
|
||||
return result
|
||||
|
||||
def remove_pool_member(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.remove_member_v2(pool_names=[pool], members=[members])
|
||||
|
||||
def add_pool_member(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.add_member_v2(pool_names=[pool], members=[members])
|
||||
|
||||
def get_connection_limit(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
result = api.LocalLB.Pool.get_member_connection_limit(pool_names=[pool], members=[members])[0][0]
|
||||
return result
|
||||
|
||||
def set_connection_limit(api, pool, address, port, limit):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.set_member_connection_limit(pool_names=[pool], members=[members], limits=[[limit]])
|
||||
|
||||
def get_description(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
result = api.LocalLB.Pool.get_member_description(pool_names=[pool], members=[members])[0][0]
|
||||
return result
|
||||
|
||||
def set_description(api, pool, address, port, description):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.set_member_description(pool_names=[pool], members=[members], descriptions=[[description]])
|
||||
|
||||
def get_rate_limit(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
result = api.LocalLB.Pool.get_member_rate_limit(pool_names=[pool], members=[members])[0][0]
|
||||
return result
|
||||
|
||||
def set_rate_limit(api, pool, address, port, limit):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.set_member_rate_limit(pool_names=[pool], members=[members], limits=[[limit]])
|
||||
|
||||
def get_ratio(api, pool, address, port):
|
||||
members = [{'address': address, 'port': port}]
|
||||
result = api.LocalLB.Pool.get_member_ratio(pool_names=[pool], members=[members])[0][0]
|
||||
return result
|
||||
|
||||
def set_ratio(api, pool, address, port, ratio):
|
||||
members = [{'address': address, 'port': port}]
|
||||
api.LocalLB.Pool.set_member_ratio(pool_names=[pool], members=[members], ratios=[[ratio]])
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec = dict(
|
||||
server = dict(type='str', required=True),
|
||||
user = dict(type='str', required=True),
|
||||
password = dict(type='str', required=True),
|
||||
state = dict(type='str', default='present', choices=['present', 'absent']),
|
||||
pool = dict(type='str', required=True),
|
||||
partition = dict(type='str', default='Common'),
|
||||
host = dict(type='str', required=True, aliases=['address', 'name']),
|
||||
port = dict(type='int', required=True),
|
||||
connection_limit = dict(type='int'),
|
||||
description = dict(type='str'),
|
||||
rate_limit = dict(type='int'),
|
||||
ratio = dict(type='int')
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not bigsuds_found:
|
||||
module.fail_json(msg="the python bigsuds module is required")
|
||||
|
||||
server = module.params['server']
|
||||
user = module.params['user']
|
||||
password = module.params['password']
|
||||
state = module.params['state']
|
||||
partition = module.params['partition']
|
||||
pool = "/%s/%s" % (partition, module.params['pool'])
|
||||
connection_limit = module.params['connection_limit']
|
||||
description = module.params['description']
|
||||
rate_limit = module.params['rate_limit']
|
||||
ratio = module.params['ratio']
|
||||
host = module.params['host']
|
||||
address = "/%s/%s" % (partition, host)
|
||||
port = module.params['port']
|
||||
|
||||
# sanity check user supplied values
|
||||
|
||||
if (host and not port) or (port and not host):
|
||||
module.fail_json(msg="both host and port must be supplied")
|
||||
|
||||
if 1 > port > 65535:
|
||||
module.fail_json(msg="valid ports must be in range 1 - 65535")
|
||||
|
||||
try:
|
||||
api = bigip_api(server, user, password)
|
||||
if not pool_exists(api, pool):
|
||||
module.fail_json(msg="pool %s does not exist" % pool)
|
||||
result = {'changed': False} # default
|
||||
|
||||
if state == 'absent':
|
||||
if member_exists(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
remove_pool_member(api, pool, address, port)
|
||||
deleted = delete_node_address(api, address)
|
||||
result = {'changed': True, 'deleted': deleted}
|
||||
else:
|
||||
result = {'changed': True}
|
||||
|
||||
elif state == 'present':
|
||||
if not member_exists(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
add_pool_member(api, pool, address, port)
|
||||
if connection_limit is not None:
|
||||
set_connection_limit(api, pool, address, port, connection_limit)
|
||||
if description is not None:
|
||||
set_description(api, pool, address, port, description)
|
||||
if rate_limit is not None:
|
||||
set_rate_limit(api, pool, address, port, rate_limit)
|
||||
if ratio is not None:
|
||||
set_ratio(api, pool, address, port, ratio)
|
||||
result = {'changed': True}
|
||||
else:
|
||||
# pool member exists -- potentially modify attributes
|
||||
if connection_limit is not None and connection_limit != get_connection_limit(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
set_connection_limit(api, pool, address, port, connection_limit)
|
||||
result = {'changed': True}
|
||||
if description is not None and description != get_description(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
set_description(api, pool, address, port, description)
|
||||
result = {'changed': True}
|
||||
if rate_limit is not None and rate_limit != get_rate_limit(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
set_rate_limit(api, pool, address, port, rate_limit)
|
||||
result = {'changed': True}
|
||||
if ratio is not None and ratio != get_ratio(api, pool, address, port):
|
||||
if not module.check_mode:
|
||||
set_ratio(api, pool, address, port, ratio)
|
||||
result = {'changed': True}
|
||||
|
||||
except Exception, e:
|
||||
module.fail_json(msg="received exception: %s" % e)
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
# include magic from lib/ansible/module_common.py
|
||||
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
||||
main()
|
||||
|
||||
Loading…
Reference in a new issue