mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
New Module for SmartOS: nictagadm (#35919)
* added nictagadm functionality for smartos * Added mac address assertion and mutex's for etherstub params * removed old commented code * Responding to ansibot lint * Responding to ansibot lint underscore * doc wording, if rc to return rc * Version Added bump to 2.6 * Grammer Fix * match documentation with the arg spec * removed default from Options since None evidently is 'None' * Guessing to please the linter, No documentation * Various changes * PEP8 fixes
This commit is contained in:
Smithx10
Dag Wieers
parent
64b57908bc
commit
e7a113a70f
1 changed files with 241 additions and 0 deletions
241
lib/ansible/modules/cloud/smartos/nictagadm.py
Normal file
241
lib/ansible/modules/cloud/smartos/nictagadm.py
Normal file
|
|
@ -0,0 +1,241 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2018, Bruce Smith <Bruce.Smith.IT@gmail.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: nictagadm
|
||||
short_description: Manage nic tags on SmartOS systems
|
||||
description:
|
||||
- Create or delete nic tags on SmartOS systems.
|
||||
version_added: '2.8'
|
||||
author:
|
||||
- Bruce Smith (@SmithX10)
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the nic tag.
|
||||
required: true
|
||||
type: str
|
||||
mac:
|
||||
description:
|
||||
- Specifies the I(mac) address to attach the nic tag to when not creating an I(etherstub).
|
||||
- Parameters I(mac) and I(etherstub) are mutually exclusive.
|
||||
type: str
|
||||
etherstub:
|
||||
description:
|
||||
- Specifies that the nic tag will be attached to a created I(etherstub).
|
||||
- Parameter I(etherstub) is mutually exclusive with both I(mtu), and I(mac).
|
||||
type: bool
|
||||
default: no
|
||||
mtu:
|
||||
description:
|
||||
- Specifies the size of the I(mtu) of the desired nic tag.
|
||||
- Parameters I(mtu) and I(etherstub) are mutually exclusive.
|
||||
type: int
|
||||
force:
|
||||
description:
|
||||
- When I(state) is absent set this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs.
|
||||
type: bool
|
||||
default: no
|
||||
state:
|
||||
description:
|
||||
- Create or delete a SmartOS nic tag.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Create 'storage0' on '00:1b:21:a3:f5:4d'
|
||||
nictagadm:
|
||||
name: storage0
|
||||
mac: 00:1b:21:a3:f5:4d
|
||||
mtu: 9000
|
||||
state: present
|
||||
|
||||
- name: Remove 'storage0' nic tag
|
||||
nictagadm:
|
||||
name: storage0
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
name:
|
||||
description: nic tag name
|
||||
returned: always
|
||||
type: str
|
||||
sample: storage0
|
||||
mac:
|
||||
description: MAC Address that the nic tag was attached to.
|
||||
returned: always
|
||||
type: str
|
||||
sample: 00:1b:21:a3:f5:4d
|
||||
etherstub:
|
||||
description: specifies if the nic tag will create and attach to an etherstub.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: False
|
||||
mtu:
|
||||
description: specifies which MTU size was passed during the nictagadm add command. mtu and etherstub are mutually exclusive.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 1500
|
||||
force:
|
||||
description: Shows if -f was used during the deletion of a nic tag
|
||||
returned: always
|
||||
type: bool
|
||||
sample: False
|
||||
state:
|
||||
description: state of the target
|
||||
returned: always
|
||||
type: str
|
||||
sample: present
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
import re
|
||||
|
||||
|
||||
class NicTag(object):
|
||||
|
||||
def __init__(self, module):
|
||||
self.module = module
|
||||
|
||||
self.name = module.params['name']
|
||||
self.mac = module.params['mac']
|
||||
self.etherstub = module.params['etherstub']
|
||||
self.mtu = module.params['mtu']
|
||||
self.force = module.params['force']
|
||||
self.state = module.params['state']
|
||||
|
||||
self.nictagadm_bin = self.module.get_bin_path('nictagadm', True)
|
||||
|
||||
def is_valid_mac(self):
|
||||
if re.match("[0-9a-f]{2}([:])[0-9a-f]{2}(\\1[0-9a-f]{2}){4}$", self.mac.lower()):
|
||||
return True
|
||||
return False
|
||||
|
||||
def nictag_exists(self):
|
||||
cmd = [self.nictagadm_bin]
|
||||
|
||||
cmd.append('exists')
|
||||
cmd.append(self.name)
|
||||
|
||||
(rc, dummy, dummy) = self.module.run_command(cmd)
|
||||
|
||||
return rc == 0
|
||||
|
||||
def add_nictag(self):
|
||||
cmd = [self.nictagadm_bin]
|
||||
|
||||
cmd.append('-v')
|
||||
cmd.append('add')
|
||||
|
||||
if self.etherstub:
|
||||
cmd.append('-l')
|
||||
|
||||
if self.mtu:
|
||||
cmd.append('-p')
|
||||
cmd.append('mtu=' + str(self.mtu))
|
||||
|
||||
if self.mac:
|
||||
cmd.append('-p')
|
||||
cmd.append('mac=' + str(self.mac))
|
||||
|
||||
cmd.append(self.name)
|
||||
|
||||
return self.module.run_command(cmd)
|
||||
|
||||
def delete_nictag(self):
|
||||
cmd = [self.nictagadm_bin]
|
||||
|
||||
cmd.append('-v')
|
||||
cmd.append('delete')
|
||||
|
||||
if self.force:
|
||||
cmd.append('-f')
|
||||
|
||||
cmd.append(self.name)
|
||||
|
||||
return self.module.run_command(cmd)
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
name=dict(type='str', required=True),
|
||||
mac=dict(type='str'),
|
||||
etherstub=dict(type='bool', default=False),
|
||||
mtu=dict(type='int'),
|
||||
force=dict(type='bool', default=False),
|
||||
state=dict(type='str', default='present', choices=['absent', 'present']),
|
||||
),
|
||||
mutually_exclusive=[
|
||||
['etherstub', 'mac'],
|
||||
['etherstub', 'mtu'],
|
||||
],
|
||||
required_if=[
|
||||
['etherstub', False, ['name', 'mac']],
|
||||
['state', 'absent', ['name', 'force']],
|
||||
],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
nictag = NicTag(module)
|
||||
|
||||
rc = None
|
||||
out = ''
|
||||
err = ''
|
||||
result = dict(
|
||||
changed=False,
|
||||
etherstub=nictag.etherstub,
|
||||
force=nictag.force,
|
||||
name=nictag.name,
|
||||
mac=nictag.mac,
|
||||
mtu=nictag.mtu,
|
||||
state=nictag.state,
|
||||
)
|
||||
|
||||
if not nictag.is_valid_mac():
|
||||
module.fail_json(msg='Invalid MAC Address Value',
|
||||
name=nictag.name,
|
||||
mac=nictag.mac,
|
||||
etherstub=nictag.etherstub)
|
||||
|
||||
if nictag.state == 'absent':
|
||||
if nictag.nictag_exists():
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=True)
|
||||
(rc, out, err) = nictag.delete_nictag()
|
||||
if rc != 0:
|
||||
module.fail_json(name=nictag.name, msg=err, rc=rc)
|
||||
elif nictag.state == 'present':
|
||||
if not nictag.nictag_exists():
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=True)
|
||||
(rc, out, err) = nictag.add_nictag()
|
||||
if rc is not None and rc != 0:
|
||||
module.fail_json(name=nictag.name, msg=err, rc=rc)
|
||||
|
||||
if rc is not None:
|
||||
result['changed'] = True
|
||||
if out:
|
||||
result['stdout'] = out
|
||||
if err:
|
||||
result['stderr'] = err
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue