Skip to content

Commit

Permalink
Creating adminrole Ansible module
Browse files Browse the repository at this point in the history
Created a module that can create and remove Infoblox NIOS adminroles
objects using the Infoblox WAPI interface over REST.
  • Loading branch information
Andrew Heath committed Feb 14, 2025
1 parent dcd53cf commit d0cf420
Show file tree
Hide file tree
Showing 2 changed files with 133 additions and 0 deletions.
1 change: 1 addition & 0 deletions plugins/module_utils/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
NIOS_EXTENSIBLE_ATTRIBUTE = 'extensibleattributedef'
NIOS_VLAN = 'vlan'
NIOS_ADMINUSER = 'adminuser'
NIOS_ADMINROLE = 'adminrole'

NIOS_PROVIDER_SPEC = {
'host': dict(fallback=(env_fallback, ['INFOBLOX_HOST'])),
Expand Down
132 changes: 132 additions & 0 deletions plugins/modules/nios_adminrole.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
#!/usr/bin/python
# Copyright (c) 2018-2019 Red Hat, Inc.
# Copyright (c) 2020 Infoblox, Inc.
# 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

DOCUMENTATION = r'''
---
module: nios_adminrole
author: "Andrew Heath (@aheath1992)"
short_description: Configure Infoblox NIOS Roles
version_added:
description:
- Adds and/or removes instances of adminrole objects from
Infoblox NIOS servers. This module manages NIOS C(adminrole) objects
using the Infoblox WAPI interface over REST.
requirements:
- infoblox-client
extends_documentation_fragment: infoblox.nios_modules.nios
notes:
- This module supports C(check_mode).
options:
name:
description:
- Specifies the adminrole name to add or remove from the system.
Users can also update the name as it is possible
to pass a dict containing I(new_name), I(old_name). See examples.
required: true
type: str
disable:
description:
- Determines whether the admin role is disabled or not. When this is set
to False, the admin role is enabled.
default: false
type: bool
extattrs:
description:
- Allows for the configuration of Extensible Attributes on the
instance of the object. This argument accepts a set of key / value
pairs for configuration.
type: dict
comment:
description:
- Configures a text string comment to be associated with the instance
of this object. The provided text string will be configured on the
object instance.
type: str
state:
description:
- Configures the intended state of the instance of the object on
the NIOS server. When this value is set to C(present), the object
is configured on the device and when this value is set to C(absent)
the value is removed (if necessary) from the device.
default: present
choices:
- present
- absent
type: str
'''

EXAMPLES = r'''
- name: Create a new admin role
infoblox.nios_modules.nios_adminrole:
name: ansible_role
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Update admin role name
infoblox.nios_modules.nios_adminrole:
name: {new_name: new_role, old_name: ansible_role}
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Remove admin role
infoblox.nios_modules.nios_adminrole:
name: new_role
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
'''

RETURN = ''' # '''

from ansible.module_utils.basic import AnsibleModule
from ..module_utils.api import WapiModule
from ..module_utils.api import NIOS_ADMINROLE
from ..module_utils.api import normalize_ib_spec


def main():
''' Main entry point for module execution
'''

ib_spec = dict(
name=dict(required=True, ib_req=True),
comment=dict(),
disable=dict(type='bool', default=False),
extattrs=dict(type='dict')
)

argument_spec = dict(
provider=dict(required=True),
state=dict(default='present', choices=['present', 'absent'])
)

argument_spec.update(normalize_ib_spec(ib_spec))
argument_spec.update(WapiModule.provider_spec)

module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True)

wapi = WapiModule(module)
result = wapi.run(NIOS_ADMINROLE, ib_spec)

module.exit_json(**result)


if __name__ == '__main__':
main()

0 comments on commit d0cf420

Please sign in to comment.