Merge pull request #582 from Etienne-Carriere/f5_vs
Creation of F5 virtual_server module
This commit is contained in:
Toshio Kuratomi
commit
f5d9a0568c
1 changed files with 465 additions and 0 deletions
465
network/f5/bigip_virtual_server.py
Normal file
465
network/f5/bigip_virtual_server.py
Normal file
|
|
@ -0,0 +1,465 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2015, Etienne Carriere <etienne.carriere@gmail.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_virtual_server
|
||||
short_description: "Manages F5 BIG-IP LTM virtual servers"
|
||||
description:
|
||||
- "Manages F5 BIG-IP LTM virtual servers via iControl SOAP API"
|
||||
version_added: "2.0"
|
||||
author: Etienne Carriere (@Etienne-Carriere)
|
||||
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"
|
||||
requirements:
|
||||
- bigsuds
|
||||
options:
|
||||
server:
|
||||
description:
|
||||
- BIG-IP host
|
||||
required: true
|
||||
user:
|
||||
description:
|
||||
- BIG-IP username
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- BIG-IP password
|
||||
required: true
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
state:
|
||||
description:
|
||||
- Virtual Server state
|
||||
required: false
|
||||
default: present
|
||||
description:
|
||||
- Absent : delete the VS if present
|
||||
- present (and its synonym enabled) : create if needed the VS and set state to enabled
|
||||
- absent : create if needed the VS and set state to disabled
|
||||
choices: ['present', 'absent', 'enabled', 'disabled']
|
||||
aliases: []
|
||||
partition:
|
||||
description:
|
||||
- Partition
|
||||
required: false
|
||||
default: 'Common'
|
||||
name:
|
||||
description:
|
||||
- "Virtual server name."
|
||||
required: true
|
||||
aliases: ['vs']
|
||||
destination:
|
||||
description:
|
||||
- "Destination IP of the virtual server (only host is currently supported) . Required when state=present and vs does not exist."
|
||||
required: true
|
||||
aliases: ['address', 'ip']
|
||||
port:
|
||||
description:
|
||||
- "Port of the virtual server . Required when state=present and vs does not exist"
|
||||
required: false
|
||||
default: None
|
||||
all_profiles:
|
||||
description:
|
||||
- "List of all Profiles (HTTP,ClientSSL,ServerSSL,etc) that must be used by the virtual server"
|
||||
required: false
|
||||
default: None
|
||||
pool:
|
||||
description:
|
||||
- "Default pool for the virtual server"
|
||||
required: false
|
||||
default: None
|
||||
snat:
|
||||
description:
|
||||
- "Source network address policy"
|
||||
required: false
|
||||
default: None
|
||||
default_persistence_profile:
|
||||
description:
|
||||
- "Default Profile which manages the session persistence"
|
||||
required: false
|
||||
default: None
|
||||
description:
|
||||
description:
|
||||
- "Virtual server description."
|
||||
required: false
|
||||
default: None
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
## playbook task examples:
|
||||
|
||||
---
|
||||
# file bigip-test.yml
|
||||
# ...
|
||||
- name: Add VS
|
||||
local_action:
|
||||
module: bigip_virtual_server
|
||||
server: lb.mydomain.net
|
||||
user: admin
|
||||
password: secret
|
||||
state: present
|
||||
partition: MyPartition
|
||||
name: myvirtualserver
|
||||
destination: "{{ ansible_default_ipv4['address'] }}"
|
||||
port: 443
|
||||
pool: "{{ mypool }}"
|
||||
snat: Automap
|
||||
description: Test Virtual Server
|
||||
all_profiles:
|
||||
- http
|
||||
- clientssl
|
||||
|
||||
- name: Modify Port of the Virtual Server
|
||||
local_action:
|
||||
module: bigip_virtual_server
|
||||
server: lb.mydomain.net
|
||||
user: admin
|
||||
password: secret
|
||||
state: present
|
||||
partition: MyPartition
|
||||
name: myvirtualserver
|
||||
port: 8080
|
||||
|
||||
- name: Delete pool
|
||||
local_action:
|
||||
module: bigip_virtual_server
|
||||
server: lb.mydomain.net
|
||||
user: admin
|
||||
password: secret
|
||||
state: absent
|
||||
partition: MyPartition
|
||||
name: myvirtualserver
|
||||
'''
|
||||
|
||||
|
||||
# ==========================
|
||||
# bigip_virtual_server module specific
|
||||
#
|
||||
|
||||
# map of state values
|
||||
STATES={'enabled': 'STATE_ENABLED',
|
||||
'disabled': 'STATE_DISABLED'}
|
||||
STATUSES={'enabled': 'SESSION_STATUS_ENABLED',
|
||||
'disabled': 'SESSION_STATUS_DISABLED',
|
||||
'offline': 'SESSION_STATUS_FORCED_DISABLED'}
|
||||
|
||||
def vs_exists(api, vs):
|
||||
# hack to determine if pool exists
|
||||
result = False
|
||||
try:
|
||||
api.LocalLB.VirtualServer.get_object_status(virtual_servers=[vs])
|
||||
result = True
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "was not found" in str(e):
|
||||
result = False
|
||||
else:
|
||||
# genuine exception
|
||||
raise
|
||||
return result
|
||||
|
||||
def vs_create(api,name,destination,port,pool):
|
||||
_profiles=[[{'profile_context': 'PROFILE_CONTEXT_TYPE_ALL', 'profile_name': 'tcp'}]]
|
||||
created = False
|
||||
# a bit of a hack to handle concurrent runs of this module.
|
||||
# even though we've checked the vs doesn't exist,
|
||||
# it may exist by the time we run create_vs().
|
||||
# this catches the exception and does something smart
|
||||
# about it!
|
||||
try:
|
||||
api.LocalLB.VirtualServer.create(
|
||||
definitions = [{'name': [name], 'address': [destination], 'port': port, 'protocol': 'PROTOCOL_TCP'}],
|
||||
wildmasks = ['255.255.255.255'],
|
||||
resources = [{'type': 'RESOURCE_TYPE_POOL', 'default_pool_name': pool}],
|
||||
profiles = _profiles)
|
||||
created = True
|
||||
return created
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "already exists" not in str(e):
|
||||
raise Exception('Error on creating Virtual Server : %s' % e)
|
||||
|
||||
def vs_remove(api,name):
|
||||
api.LocalLB.VirtualServer.delete_virtual_server(virtual_servers = [name ])
|
||||
|
||||
def get_profiles(api,name):
|
||||
return api.LocalLB.VirtualServer.get_profile(virtual_servers = [name])[0]
|
||||
|
||||
|
||||
|
||||
def set_profiles(api,name,profiles_list):
|
||||
updated=False
|
||||
try:
|
||||
if profiles_list is None:
|
||||
return False
|
||||
current_profiles=map(lambda x:x['profile_name'], get_profiles(api,name))
|
||||
to_add_profiles=[]
|
||||
for x in profiles_list:
|
||||
if x not in current_profiles:
|
||||
to_add_profiles.append({'profile_context': 'PROFILE_CONTEXT_TYPE_ALL', 'profile_name': x})
|
||||
to_del_profiles=[]
|
||||
for x in current_profiles:
|
||||
if (x not in profiles_list) and (x!= "/Common/tcp"):
|
||||
to_del_profiles.append({'profile_context': 'PROFILE_CONTEXT_TYPE_ALL', 'profile_name': x})
|
||||
if len(to_del_profiles)>0:
|
||||
api.LocalLB.VirtualServer.remove_profile(virtual_servers = [name],profiles = [to_del_profiles])
|
||||
updated=True
|
||||
if len(to_add_profiles)>0:
|
||||
api.LocalLB.VirtualServer.add_profile(virtual_servers = [name],profiles= [to_add_profiles])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting profiles : %s' % e)
|
||||
|
||||
def set_snat(api,name,snat):
|
||||
updated = False
|
||||
try:
|
||||
current_state=get_snat_type(api,name)
|
||||
if snat is None:
|
||||
return updated
|
||||
elif snat == 'None' and current_state != 'SRC_TRANS_NONE':
|
||||
api.LocalLB.VirtualServer.set_source_address_translation_none(virtual_servers = [name])
|
||||
updated = True
|
||||
elif snat == 'Automap' and current_state != 'SRC_TRANS_AUTOMAP':
|
||||
api.LocalLB.VirtualServer.set_source_address_translation_automap(virtual_servers = [name])
|
||||
updated = True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting snat : %s' % e)
|
||||
|
||||
def get_snat_type(api,name):
|
||||
return api.LocalLB.VirtualServer.get_source_address_translation_type(virtual_servers = [name])[0]
|
||||
|
||||
|
||||
def get_pool(api,name):
|
||||
return api.LocalLB.VirtualServer.get_default_pool_name(virtual_servers = [name])[0]
|
||||
|
||||
def set_pool(api,name,pool):
|
||||
updated=False
|
||||
try:
|
||||
current_pool = get_pool (api,name)
|
||||
if pool is not None and (pool != current_pool):
|
||||
api.LocalLB.VirtualServer.set_default_pool_name(virtual_servers = [name],default_pools = [pool])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting pool : %s' % e)
|
||||
|
||||
|
||||
def get_destination(api,name):
|
||||
return api.LocalLB.VirtualServer.get_destination_v2(virtual_servers = [name])[0]
|
||||
|
||||
def set_destination(api,name,destination):
|
||||
updated=False
|
||||
try:
|
||||
current_destination = get_destination(api,name)
|
||||
if destination is not None and destination != current_destination['address']:
|
||||
api.LocalLB.VirtualServer.set_destination_v2(virtual_servers = [name],destinations=[{'address': destination, 'port': current_destination['port']}])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting destination : %s'% e )
|
||||
|
||||
|
||||
def set_port(api,name,port):
|
||||
updated=False
|
||||
try:
|
||||
current_destination = get_destination(api,name)
|
||||
if port is not None and port != current_destination['port']:
|
||||
api.LocalLB.VirtualServer.set_destination_v2(virtual_servers = [name],destinations=[{'address': current_destination['address'], 'port': port}])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting port : %s'% e )
|
||||
|
||||
def get_state(api,name):
|
||||
return api.LocalLB.VirtualServer.get_enabled_state(virtual_servers = [name])[0]
|
||||
|
||||
def set_state(api,name,state):
|
||||
updated=False
|
||||
try:
|
||||
current_state=get_state(api,name)
|
||||
# We consider that being present is equivalent to enabled
|
||||
if state == 'present':
|
||||
state='enabled'
|
||||
if STATES[state] != current_state:
|
||||
api.LocalLB.VirtualServer.set_enabled_state(virtual_servers=[name],states=[STATES[state]])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting state : %s'% e )
|
||||
|
||||
def get_description(api,name):
|
||||
return api.LocalLB.VirtualServer.get_description(virtual_servers = [name])[0]
|
||||
|
||||
def set_description(api,name,description):
|
||||
updated=False
|
||||
try:
|
||||
current_description = get_description(api,name)
|
||||
if description is not None and current_description != description:
|
||||
api.LocalLB.VirtualServer.set_description(virtual_servers =[name],descriptions=[description])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting description : %s ' % e)
|
||||
|
||||
def get_persistence_profiles(api,name):
|
||||
return api.LocalLB.VirtualServer.get_persistence_profile(virtual_servers = [name])[0]
|
||||
|
||||
def set_default_persistence_profiles(api,name,persistence_profile):
|
||||
updated=False
|
||||
if persistence_profile is None:
|
||||
return updated
|
||||
try:
|
||||
current_persistence_profiles = get_persistence_profiles(api,name)
|
||||
default=None
|
||||
for profile in current_persistence_profiles:
|
||||
if profile['default_profile']:
|
||||
default=profile['profile_name']
|
||||
break
|
||||
if default is not None and default != persistence_profile:
|
||||
api.LocalLB.VirtualServer.remove_persistence_profile(virtual_servers=[name],profiles=[[{'profile_name':default,'default_profile' : True}]])
|
||||
if default != persistence_profile:
|
||||
api.LocalLB.VirtualServer.add_persistence_profile(virtual_servers=[name],profiles=[[{'profile_name':persistence_profile,'default_profile' : True}]])
|
||||
updated=True
|
||||
return updated
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on setting default persistence profile : %s' % e)
|
||||
|
||||
def main():
|
||||
argument_spec = f5_argument_spec()
|
||||
argument_spec.update( dict(
|
||||
state = dict(type='str', default='present',
|
||||
choices=['present', 'absent', 'disabled', 'enabled']),
|
||||
name = dict(type='str', required=True,aliases=['vs']),
|
||||
destination = dict(type='str', aliases=['address', 'ip']),
|
||||
port = dict(type='int'),
|
||||
all_profiles = dict(type='list'),
|
||||
pool=dict(type='str'),
|
||||
description = dict(type='str'),
|
||||
snat=dict(type='str'),
|
||||
default_persistence_profile=dict(type='str')
|
||||
)
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec = argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
(server,user,password,state,partition,validate_certs) = f5_parse_arguments(module)
|
||||
name = fq_name(partition,module.params['name'])
|
||||
destination=module.params['destination']
|
||||
port=module.params['port']
|
||||
all_profiles=fq_list_names(partition,module.params['all_profiles'])
|
||||
pool=fq_name(partition,module.params['pool'])
|
||||
description = module.params['description']
|
||||
snat = module.params['snat']
|
||||
default_persistence_profile=fq_name(partition,module.params['default_persistence_profile'])
|
||||
|
||||
if 1 > port > 65535:
|
||||
module.fail_json(msg="valid ports must be in range 1 - 65535")
|
||||
|
||||
try:
|
||||
api = bigip_api(server, user, password)
|
||||
result = {'changed': False} # default
|
||||
|
||||
if state == 'absent':
|
||||
if not module.check_mode:
|
||||
if vs_exists(api,name):
|
||||
# hack to handle concurrent runs of module
|
||||
# pool might be gone before we actually remove
|
||||
try:
|
||||
vs_remove(api,name)
|
||||
result = {'changed' : True, 'deleted' : name }
|
||||
except bigsuds.OperationFailed, e:
|
||||
if "was not found" in str(e):
|
||||
result['changed']= False
|
||||
else:
|
||||
raise
|
||||
else:
|
||||
# check-mode return value
|
||||
result = {'changed': True}
|
||||
|
||||
else:
|
||||
update = False
|
||||
if not vs_exists(api, name):
|
||||
if (not destination) or (not port):
|
||||
module.fail_json(msg="both destination and port must be supplied to create a VS")
|
||||
if not module.check_mode:
|
||||
# a bit of a hack to handle concurrent runs of this module.
|
||||
# even though we've checked the virtual_server doesn't exist,
|
||||
# it may exist by the time we run virtual_server().
|
||||
# this catches the exception and does something smart
|
||||
# about it!
|
||||
try:
|
||||
vs_create(api,name,destination,port,pool)
|
||||
set_profiles(api,name,all_profiles)
|
||||
set_snat(api,name,snat)
|
||||
set_description(api,name,description)
|
||||
set_default_persistence_profiles(api,name,default_persistence_profile)
|
||||
set_state(api,name,state)
|
||||
result = {'changed': True}
|
||||
except bigsuds.OperationFailed, e:
|
||||
raise Exception('Error on creating Virtual Server : %s' % e)
|
||||
else:
|
||||
# check-mode return value
|
||||
result = {'changed': True}
|
||||
else:
|
||||
update = True
|
||||
if update:
|
||||
# VS exists
|
||||
if not module.check_mode:
|
||||
# Have a transaction for all the changes
|
||||
try:
|
||||
api.System.Session.start_transaction()
|
||||
result['changed']|=set_destination(api,name,fq_name(partition,destination))
|
||||
result['changed']|=set_port(api,name,port)
|
||||
result['changed']|=set_pool(api,name,pool)
|
||||
result['changed']|=set_description(api,name,description)
|
||||
result['changed']|=set_snat(api,name,snat)
|
||||
result['changed']|=set_profiles(api,name,all_profiles)
|
||||
result['changed']|=set_default_persistence_profiles(api,name,default_persistence_profile)
|
||||
result['changed']|=set_state(api,name,state)
|
||||
api.System.Session.submit_transaction()
|
||||
except Exception,e:
|
||||
raise Exception("Error on updating Virtual Server : %s" % e)
|
||||
else:
|
||||
# check-mode return value
|
||||
result = {'changed': True}
|
||||
|
||||
except Exception, e:
|
||||
module.fail_json(msg="received exception: %s" % e)
|
||||
|
||||
module.exit_json(**result)
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.f5 import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
Loading…
Reference in a new issue