Adds the bigip_selfip module
Another bootstrapping module, this module allows for one to manage self IP addresses on a BIG-IP. Tests for this module can be found here https://github.com/F5Networks/f5-ansible/blob/master/roles/__bigip_selfip/tasks/main.yaml Platforms this was tested on are 11.5.4 HF1 11.6.0 12.0.0 12.1.0 HF1
This commit is contained in:
Tim Rupp
Matt Clay
parent
685803dbcc
commit
f84b4f1168
1 changed files with 449 additions and 0 deletions
449
lib/ansible/modules/extras/network/f5/bigip_selfip.py
Normal file
449
lib/ansible/modules/extras/network/f5/bigip_selfip.py
Normal file
|
|
@ -0,0 +1,449 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# 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_selfip
|
||||
short_description: Manage Self-IPs on a BIG-IP system
|
||||
description:
|
||||
- Manage Self-IPs on a BIG-IP system
|
||||
version_added: "2.2"
|
||||
options:
|
||||
address:
|
||||
description:
|
||||
- The IP addresses for the new self IP. This value is ignored upon update
|
||||
as addresses themselves cannot be changed after they are created.
|
||||
name:
|
||||
description:
|
||||
- The self IP to create.
|
||||
required: true
|
||||
default: Value of C(address)
|
||||
netmask:
|
||||
description:
|
||||
- The netmasks for the self IP.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- The state of the variable on the system. When C(present), guarantees
|
||||
that the Self-IP exists with the provided attributes. When C(absent),
|
||||
removes the Self-IP from the system.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
traffic_group:
|
||||
description:
|
||||
- The traffic group for the self IP addresses in an active-active,
|
||||
redundant load balancer configuration.
|
||||
required: false
|
||||
vlan:
|
||||
description:
|
||||
- The VLAN that the new self IPs will be on.
|
||||
required: true
|
||||
notes:
|
||||
- Requires the f5-sdk Python package on the host. This is as easy as pip
|
||||
install f5-sdk.
|
||||
- Requires the netaddr Python package on the host.
|
||||
extends_documentation_fragment: f5
|
||||
requirements:
|
||||
- netaddr
|
||||
- f5-sdk
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create Self IP
|
||||
bigip_selfip:
|
||||
address: "10.10.10.10"
|
||||
name: "self1"
|
||||
netmask: "255.255.255.0"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
user: "admin"
|
||||
validate_certs: "no"
|
||||
vlan: "vlan1"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Delete Self IP
|
||||
bigip_selfip:
|
||||
name: "self1"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
state: "absent"
|
||||
user: "admin"
|
||||
validate_certs: "no"
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
address:
|
||||
description: The address for the Self IP
|
||||
returned: created
|
||||
type: string
|
||||
sample: "192.168.10.10"
|
||||
name:
|
||||
description: The name of the Self IP
|
||||
returned:
|
||||
- created
|
||||
- changed
|
||||
- deleted
|
||||
type: string
|
||||
sample: "self1"
|
||||
netmask:
|
||||
description: The netmask of the Self IP
|
||||
returned:
|
||||
- changed
|
||||
- created
|
||||
type: string
|
||||
sample: "255.255.255.0"
|
||||
traffic_group:
|
||||
description: The traffic group that the Self IP is a member of
|
||||
return:
|
||||
- changed
|
||||
- created
|
||||
type: string
|
||||
sample: "traffic-group-local-only"
|
||||
vlan:
|
||||
description: The VLAN set on the Self IP
|
||||
return:
|
||||
- changed
|
||||
- created
|
||||
type: string
|
||||
sample: "vlan1"
|
||||
'''
|
||||
|
||||
try:
|
||||
from f5.bigip import ManagementRoot
|
||||
from icontrol.session import iControlUnexpectedHTTPError
|
||||
HAS_F5SDK = True
|
||||
except ImportError:
|
||||
HAS_F5SDK = False
|
||||
|
||||
try:
|
||||
from netaddr import IPNetwork, AddrFormatError
|
||||
HAS_NETADDR = True
|
||||
except ImportError:
|
||||
HAS_NETADDR = False
|
||||
|
||||
FLOAT = ['enabled', 'disabled']
|
||||
DEFAULT_TG = 'traffic-group-local-only'
|
||||
|
||||
|
||||
class BigIpSelfIp(object):
|
||||
def __init__(self, *args, **kwargs):
|
||||
if not HAS_F5SDK:
|
||||
raise F5ModuleError("The python f5-sdk module is required")
|
||||
|
||||
# The params that change in the module
|
||||
self.cparams = dict()
|
||||
|
||||
# Stores the params that are sent to the module
|
||||
self.params = kwargs
|
||||
self.api = ManagementRoot(kwargs['server'],
|
||||
kwargs['user'],
|
||||
kwargs['password'],
|
||||
port=kwargs['server_port'])
|
||||
|
||||
def present(self):
|
||||
changed = False
|
||||
|
||||
if self.exists():
|
||||
changed = self.update()
|
||||
else:
|
||||
changed = self.create()
|
||||
|
||||
return changed
|
||||
|
||||
def absent(self):
|
||||
changed = False
|
||||
|
||||
if self.exists():
|
||||
changed = self.delete()
|
||||
|
||||
return changed
|
||||
|
||||
def read(self):
|
||||
"""Read information and transform it
|
||||
|
||||
The values that are returned by BIG-IP in the f5-sdk can have encoding
|
||||
attached to them as well as be completely missing in some cases.
|
||||
|
||||
Therefore, this method will transform the data from the BIG-IP into a
|
||||
format that is more easily consumable by the rest of the class and the
|
||||
parameters that are supported by the module.
|
||||
"""
|
||||
p = dict()
|
||||
name = self.params['name']
|
||||
partition = self.params['partition']
|
||||
r = self.api.tm.net.selfips.selfip.load(
|
||||
name=name,
|
||||
partition=partition
|
||||
)
|
||||
|
||||
if hasattr(r, 'address'):
|
||||
ipnet = IPNetwork(r.address)
|
||||
p['address'] = str(ipnet.ip)
|
||||
if hasattr(r, 'address'):
|
||||
ipnet = IPNetwork(r.address)
|
||||
p['netmask'] = str(ipnet.netmask)
|
||||
if hasattr(r, 'trafficGroup'):
|
||||
p['traffic_group'] = str(r.trafficGroup)
|
||||
if hasattr(r, 'vlan'):
|
||||
p['vlan'] = str(r.vlan)
|
||||
p['name'] = name
|
||||
return p
|
||||
|
||||
def update(self):
|
||||
changed = False
|
||||
params = dict()
|
||||
current = self.read()
|
||||
|
||||
check_mode = self.params['check_mode']
|
||||
address = self.params['address']
|
||||
name = self.params['name']
|
||||
netmask = self.params['netmask']
|
||||
partition = self.params['partition']
|
||||
traffic_group = self.params['traffic_group']
|
||||
vlan = self.params['vlan']
|
||||
|
||||
if address is not None and address != current['address']:
|
||||
raise F5ModuleError(
|
||||
'Self IP addresses cannot be updated'
|
||||
)
|
||||
|
||||
if netmask is not None:
|
||||
# I ignore the address value here even if they provide it because
|
||||
# you are not allowed to change it.
|
||||
try:
|
||||
address = IPNetwork(current['address'])
|
||||
|
||||
new_addr = "%s/%s" % (address.ip, netmask)
|
||||
nipnet = IPNetwork(new_addr)
|
||||
|
||||
cur_addr = "%s/%s" % (current['address'], current['netmask'])
|
||||
cipnet = IPNetwork(cur_addr)
|
||||
|
||||
if nipnet != cipnet:
|
||||
address = "%s/%s" % (nipnet.ip, nipnet.prefixlen)
|
||||
params['address'] = address
|
||||
except AddrFormatError:
|
||||
raise F5ModuleError(
|
||||
'The provided address/netmask value was invalid'
|
||||
)
|
||||
|
||||
if traffic_group is not None:
|
||||
groups = self.api.tm.cm.traffic_groups.get_collection()
|
||||
params['trafficGroup'] = "/%s/%s" % (partition, traffic_group)
|
||||
|
||||
if 'traffic_group' in current:
|
||||
if traffic_group != current['traffic_group']:
|
||||
params['trafficGroup'] = traffic_group
|
||||
else:
|
||||
params['trafficGroup'] = traffic_group
|
||||
|
||||
if traffic_group not in groups:
|
||||
raise F5ModuleError(
|
||||
'The specified traffic group was not found'
|
||||
)
|
||||
|
||||
if vlan is not None:
|
||||
vlans = self.get_vlans()
|
||||
vlan = "/%s/%s" % (partition, vlan)
|
||||
|
||||
if 'vlan' in current:
|
||||
if vlan != current['vlan']:
|
||||
params['vlan'] = vlan
|
||||
else:
|
||||
params['vlan'] = vlan
|
||||
|
||||
if vlan not in vlans:
|
||||
raise F5ModuleError(
|
||||
'The specified VLAN was not found'
|
||||
)
|
||||
|
||||
if params:
|
||||
changed = True
|
||||
params['name'] = name
|
||||
params['partition'] = partition
|
||||
if check_mode:
|
||||
return changed
|
||||
self.cparams = camel_dict_to_snake_dict(params)
|
||||
else:
|
||||
return changed
|
||||
|
||||
r = self.api.tm.net.selfips.selfip.load(
|
||||
name=name,
|
||||
partition=partition
|
||||
)
|
||||
r.update(**params)
|
||||
r.refresh()
|
||||
|
||||
return True
|
||||
|
||||
def get_vlans(self):
|
||||
partition = self.params['partition']
|
||||
vlans = self.api.tm.net.vlans.get_collection()
|
||||
return [str("/" + partition + "/" + x.name) for x in vlans]
|
||||
|
||||
def create(self):
|
||||
params = dict()
|
||||
|
||||
check_mode = self.params['check_mode']
|
||||
address = self.params['address']
|
||||
name = self.params['name']
|
||||
netmask = self.params['netmask']
|
||||
partition = self.params['partition']
|
||||
traffic_group = self.params['traffic_group']
|
||||
vlan = self.params['vlan']
|
||||
|
||||
if address is None or netmask is None:
|
||||
raise F5ModuleError(
|
||||
'An address and a netmask must be specififed'
|
||||
)
|
||||
|
||||
if vlan is None:
|
||||
raise F5ModuleError(
|
||||
'A VLAN name must be specified'
|
||||
)
|
||||
else:
|
||||
vlan = "/%s/%s" % (partition, vlan)
|
||||
|
||||
try:
|
||||
ipin = "%s/%s" % (address, netmask)
|
||||
ipnet = IPNetwork(ipin)
|
||||
params['address'] = "%s/%s" % (ipnet.ip, ipnet.prefixlen)
|
||||
except AddrFormatError:
|
||||
raise F5ModuleError(
|
||||
'The provided address/netmask value was invalid'
|
||||
)
|
||||
|
||||
if traffic_group is None:
|
||||
params['trafficGroup'] = "/%s/%s" % (partition, DEFAULT_TG)
|
||||
else:
|
||||
groups = self.api.tm.cm.traffic_groups.get_collection()
|
||||
if traffic_group in groups:
|
||||
params['trafficGroup'] = "/%s/%s" % (partition, traffic_group)
|
||||
else:
|
||||
raise F5ModuleError(
|
||||
'The specified traffic group was not found'
|
||||
)
|
||||
|
||||
vlans = self.get_vlans()
|
||||
if vlan in vlans:
|
||||
params['vlan'] = vlan
|
||||
else:
|
||||
raise F5ModuleError(
|
||||
'The specified VLAN was not found'
|
||||
)
|
||||
|
||||
params['name'] = name
|
||||
params['partition'] = partition
|
||||
|
||||
self.cparams = camel_dict_to_snake_dict(params)
|
||||
if check_mode:
|
||||
return True
|
||||
|
||||
d = self.api.tm.net.selfips.selfip
|
||||
d.create(**params)
|
||||
|
||||
if self.exists():
|
||||
return True
|
||||
else:
|
||||
raise F5ModuleError("Failed to create the self IP")
|
||||
|
||||
def delete(self):
|
||||
params = dict()
|
||||
check_mode = self.params['check_mode']
|
||||
|
||||
params['name'] = self.params['name']
|
||||
params['partition'] = self.params['partition']
|
||||
|
||||
self.cparams = camel_dict_to_snake_dict(params)
|
||||
if check_mode:
|
||||
return True
|
||||
|
||||
dc = self.api.tm.net.selfips.selfip.load(**params)
|
||||
dc.delete()
|
||||
|
||||
if self.exists():
|
||||
raise F5ModuleError("Failed to delete the self IP")
|
||||
return True
|
||||
|
||||
def exists(self):
|
||||
name = self.params['name']
|
||||
partition = self.params['partition']
|
||||
return self.api.tm.net.selfips.selfip.exists(
|
||||
name=name,
|
||||
partition=partition
|
||||
)
|
||||
|
||||
def flush(self):
|
||||
result = dict()
|
||||
state = self.params['state']
|
||||
|
||||
try:
|
||||
if state == "present":
|
||||
changed = self.present()
|
||||
elif state == "absent":
|
||||
changed = self.absent()
|
||||
except iControlUnexpectedHTTPError as e:
|
||||
raise F5ModuleError(str(e))
|
||||
|
||||
result.update(**self.cparams)
|
||||
result.update(dict(changed=changed))
|
||||
return result
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = f5_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
address=dict(required=False, default=None),
|
||||
name=dict(required=True),
|
||||
netmask=dict(required=False, default=None),
|
||||
traffic_group=dict(required=False, default=None),
|
||||
vlan=dict(required=False, default=None)
|
||||
)
|
||||
argument_spec.update(meta_args)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
try:
|
||||
if not HAS_NETADDR:
|
||||
raise F5ModuleError(
|
||||
"The netaddr python module is required."
|
||||
)
|
||||
|
||||
obj = BigIpSelfIp(check_mode=module.check_mode, **module.params)
|
||||
result = obj.flush()
|
||||
|
||||
module.exit_json(**result)
|
||||
except F5ModuleError as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.ec2 import camel_dict_to_snake_dict
|
||||
from ansible.module_utils.f5 import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue