Adds bigip_vlan module (#2661)
This module can be used to manage VLANs in BIG-IP on various software versions. It is part of a bootstrapping effort underway to provide modules necessary to bootstrap core settings in a BIG-IP. Tests for this module can be found here https://github.com/F5Networks/f5-ansible/blob/master/roles/__bigip_vlan/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
3c0a946f2d
commit
e624a794ac
1 changed files with 388 additions and 0 deletions
388
lib/ansible/modules/extras/network/f5/bigip_vlan.py
Normal file
388
lib/ansible/modules/extras/network/f5/bigip_vlan.py
Normal file
|
|
@ -0,0 +1,388 @@
|
|||
#!/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_vlan
|
||||
short_description: Manage VLANs on a BIG-IP system
|
||||
description:
|
||||
- Manage VLANs on a BIG-IP system
|
||||
version_added: "2.2"
|
||||
options:
|
||||
description:
|
||||
description:
|
||||
- The description to give to the VLAN.
|
||||
interfaces:
|
||||
description:
|
||||
- Specifies a list of tagged or untagged interfaces and trunks that you
|
||||
want to configure for the VLAN. Use tagged interfaces or trunks when
|
||||
you want to assign a single interface or trunk to multiple VLANs.
|
||||
name:
|
||||
description:
|
||||
- The VLAN to manage. If the special VLAN C(ALL) is specified with
|
||||
the C(state) value of C(absent) then all VLANs will be removed.
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- The state of the VLAN on the system. When C(present), guarantees
|
||||
that the VLAN exists with the provided attributes. When C(absent),
|
||||
removes the VLAN from the system.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
- present
|
||||
tag:
|
||||
description:
|
||||
- Tag number for the VLAN. The tag number can be any integer between 1
|
||||
and 4094. The system automatically assigns a tag number if you do not
|
||||
specify a value.
|
||||
notes:
|
||||
- Requires the f5-sdk Python package on the host. This is as easy as pip
|
||||
install f5-sdk.
|
||||
- Requires BIG-IP versions >= 12.0.0
|
||||
extends_documentation_fragment: f5
|
||||
requirements:
|
||||
- f5-sdk
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create VLAN
|
||||
bigip_vlan:
|
||||
name: "net1"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
user: "admin"
|
||||
validate_certs: "no"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Set VLAN tag
|
||||
bigip_vlan:
|
||||
name: "net1"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
tag: "2345"
|
||||
user: "admin"
|
||||
validate_certs: "no"
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Add VLAN 2345 as tagged to interface 1.1
|
||||
bigip_vlan:
|
||||
interfaces:
|
||||
- 1.1
|
||||
name: "net1"
|
||||
password: "secret"
|
||||
server: "lb.mydomain.com"
|
||||
tag: "2345"
|
||||
user: "admin"
|
||||
validate_certs: "no"
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
description:
|
||||
description: The description set on the VLAN
|
||||
returned: changed
|
||||
type: string
|
||||
sample: foo VLAN
|
||||
interfaces:
|
||||
description: Interfaces that the VLAN is assigned to
|
||||
returned: changed
|
||||
type: list
|
||||
sample: ['1.1','1.2']
|
||||
name:
|
||||
description: The name of the VLAN
|
||||
returned: changed
|
||||
type: string
|
||||
sample: net1
|
||||
partition:
|
||||
description: The partition that the VLAN was created on
|
||||
returned: changed
|
||||
type: string
|
||||
sample: Common
|
||||
tag:
|
||||
description: The ID of the VLAN
|
||||
returned: changed
|
||||
type: int
|
||||
sample: 2345
|
||||
'''
|
||||
|
||||
try:
|
||||
from f5.bigip import ManagementRoot
|
||||
from icontrol.session import iControlUnexpectedHTTPError
|
||||
HAS_F5SDK = True
|
||||
except ImportError:
|
||||
HAS_F5SDK = False
|
||||
|
||||
|
||||
class BigIpVlan(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.vlans.vlan.load(
|
||||
name=name,
|
||||
partition=partition
|
||||
)
|
||||
ifcs = r.interfaces_s.get_collection()
|
||||
if hasattr(r, 'tag'):
|
||||
p['tag'] = int(r.tag)
|
||||
if hasattr(r, 'description'):
|
||||
p['description'] = str(r.description)
|
||||
if len(ifcs) is not 0:
|
||||
p['interfaces'] = list(set([str(x.name) for x in ifcs]))
|
||||
p['name'] = name
|
||||
return p
|
||||
|
||||
def create(self):
|
||||
params = dict()
|
||||
|
||||
check_mode = self.params['check_mode']
|
||||
description = self.params['description']
|
||||
name = self.params['name']
|
||||
interfaces = self.params['interfaces']
|
||||
partition = self.params['partition']
|
||||
tag = self.params['tag']
|
||||
|
||||
if tag is not None:
|
||||
params['tag'] = tag
|
||||
|
||||
if interfaces is not None:
|
||||
ifcs = self.api.tm.net.interfaces.get_collection()
|
||||
ifcs = [str(x.name) for x in ifcs]
|
||||
|
||||
if len(ifcs) is 0:
|
||||
raise F5ModuleError(
|
||||
'No interfaces were found'
|
||||
)
|
||||
|
||||
pinterfaces = []
|
||||
for ifc in interfaces:
|
||||
ifc = str(ifc)
|
||||
if ifc in ifcs:
|
||||
pinterfaces.append(ifc)
|
||||
if pinterfaces:
|
||||
params['interfaces'] = pinterfaces
|
||||
|
||||
if description is not None:
|
||||
params['description'] = self.params['description']
|
||||
|
||||
params['name'] = name
|
||||
params['partition'] = partition
|
||||
|
||||
self.cparams = camel_dict_to_snake_dict(params)
|
||||
if check_mode:
|
||||
return True
|
||||
|
||||
d = self.api.tm.net.vlans.vlan
|
||||
d.create(**params)
|
||||
|
||||
if self.exists():
|
||||
return True
|
||||
else:
|
||||
raise F5ModuleError("Failed to create the VLAN")
|
||||
|
||||
def update(self):
|
||||
changed = False
|
||||
params = dict()
|
||||
current = self.read()
|
||||
|
||||
check_mode = self.params['check_mode']
|
||||
description = self.params['description']
|
||||
name = self.params['name']
|
||||
tag = self.params['tag']
|
||||
partition = self.params['partition']
|
||||
interfaces = self.params['interfaces']
|
||||
|
||||
if interfaces is not None:
|
||||
ifcs = self.api.tm.net.interfaces.get_collection()
|
||||
ifcs = [str(x.name) for x in ifcs]
|
||||
|
||||
if len(ifcs) is 0:
|
||||
raise F5ModuleError(
|
||||
'No interfaces were found'
|
||||
)
|
||||
|
||||
for ifc in interfaces:
|
||||
ifc = str(ifc)
|
||||
if ifc in ifcs:
|
||||
try:
|
||||
pinterfaces.append(ifc)
|
||||
except UnboundLocalError:
|
||||
pinterfaces = []
|
||||
pinterfaces.append(ifc)
|
||||
else:
|
||||
raise F5ModuleError(
|
||||
'The specified interface "%s" was not found' % (ifc)
|
||||
)
|
||||
|
||||
if 'interfaces' in current:
|
||||
if pinterfaces != current['interfaces']:
|
||||
params['interfaces'] = pinterfaces
|
||||
else:
|
||||
params['interfaces'] = pinterfaces
|
||||
|
||||
if description is not None:
|
||||
if 'description' in current:
|
||||
if description != current['description']:
|
||||
params['description'] = description
|
||||
else:
|
||||
params['description'] = description
|
||||
|
||||
if tag is not None:
|
||||
if 'tag' in current:
|
||||
if tag != current['tag']:
|
||||
params['tag'] = tag
|
||||
else:
|
||||
params['tag'] = tag
|
||||
|
||||
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.vlans.vlan.load(
|
||||
name=name,
|
||||
partition=partition
|
||||
)
|
||||
r.update(**params)
|
||||
r.refresh()
|
||||
|
||||
return True
|
||||
|
||||
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.vlans.vlan.load(**params)
|
||||
dc.delete()
|
||||
|
||||
if self.exists():
|
||||
raise F5ModuleError("Failed to delete the VLAN")
|
||||
return True
|
||||
|
||||
def exists(self):
|
||||
name = self.params['name']
|
||||
partition = self.params['partition']
|
||||
return self.api.tm.net.vlans.vlan.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(
|
||||
description=dict(required=False, default=None),
|
||||
interfaces=dict(required=False, default=None, type='list'),
|
||||
name=dict(required=True),
|
||||
tag=dict(required=False, default=None, type='int')
|
||||
)
|
||||
argument_spec.update(meta_args)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
try:
|
||||
obj = BigIpVlan(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