forked from infobloxopen/bloxone-ansible
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Next Available Address Block Support for Ansible V2 (infobloxopen#58)
* added code for next_available_address_block * added test cases for next_available_address_block * modified examples * added ipam_next_available_address_block.py to runtime.yml * modified cleanup.yml * addressed review comment * modified examples * modified examples * addressed review comments * addressed review comments
- Loading branch information
1 parent
29dfb72
commit 67fc870
Showing
10 changed files
with
293 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
plugins/modules/ipam_next_available_address_block_info.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| #!/usr/bin/python | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| # Copyright: 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: ipam_next_available_address_block_info | ||
| short_description: Manage NextAvailableAddressBlock | ||
| description: | ||
| - Manage NextAvailableAddressBlock | ||
| version_added: 2.0.0 | ||
| author: Infoblox Inc. (@infobloxopen) | ||
| options: | ||
| id: | ||
| description: | ||
| - ID of the object | ||
| type: str | ||
| required: true | ||
| cidr: | ||
| description: | ||
| - The CIDR value of the object | ||
| type: int | ||
| required: true | ||
| count: | ||
| description: | ||
| - Number of objects to generate. Default 1 if not set | ||
| type: int | ||
| required: false | ||
| extends_documentation_fragment: | ||
| - infoblox.bloxone.common | ||
| """ # noqa: E501 | ||
|
|
||
| EXAMPLES = r""" | ||
| - name: "Create an Address Block" | ||
| infoblox.bloxone.ipam_address_block: | ||
| address: "10.0.0.0/16" | ||
| space: "{{ ip_space.id }}" | ||
| state: "present" | ||
| - name: Get Next Available Address Block Information by ID | ||
| infoblox.bloxone.ipam_next_available_address_block_info: | ||
| id: "{{ address_block.id }}" | ||
| cidr: 20 | ||
| - name: Get Next Available Address Block Information by ID and Count | ||
| infoblox.bloxone.ipam_next_available_address_block_info: | ||
| id: "{{ address_block.id }}" | ||
| cidr: 24 | ||
| count: 5 | ||
| """ | ||
|
|
||
| RETURN = r""" | ||
| id: | ||
| description: | ||
| - ID of the AddressBlock object. | ||
| type: str | ||
| returned: Always | ||
| objects: | ||
| description: | ||
| - List of next available address block's addresses. | ||
| type: list | ||
| elements: str | ||
| returned: Always | ||
| """ | ||
|
|
||
| from ansible_collections.infoblox.bloxone.plugins.module_utils.modules import BloxoneAnsibleModule | ||
|
|
||
| try: | ||
| from bloxone_client import ApiException | ||
| from ipam import AddressBlockApi | ||
| except ImportError: | ||
| pass # Handled by BloxoneAnsibleModule | ||
|
|
||
|
|
||
| class NextAvailableAddressBlockInfoModule(BloxoneAnsibleModule): | ||
| def __init__(self, *args, **kwargs): | ||
| super(NextAvailableAddressBlockInfoModule, self).__init__(*args, **kwargs) | ||
| self._existing = None | ||
| self._limit = 1000 | ||
|
|
||
| def find(self): | ||
| all_results = [] | ||
| offset = 0 | ||
| while True: | ||
| try: | ||
| resp = AddressBlockApi(self.client).list_next_available_ab( | ||
| id=self.params["id"], cidr=self.params["cidr"], count=self.params["count"] | ||
| ) | ||
| all_results.extend(resp.results) | ||
|
|
||
| if len(resp.results) < self._limit: | ||
| break | ||
| offset += self._limit | ||
|
|
||
| except ApiException as e: | ||
| self.fail_json(msg=f"Failed to execute command: {e.status} {e.reason} {e.body}") | ||
|
|
||
| return all_results | ||
|
|
||
| def run_command(self): | ||
| result = dict(objects=[]) | ||
|
|
||
| if self.check_mode: | ||
| self.exit_json(**result) | ||
|
|
||
| find_results = self.find() | ||
|
|
||
| all_results = [] | ||
| for r in find_results: | ||
| # The expected output is a list of addresses as strings. | ||
| # Therefore, we extract only the 'address' field from each object in the results. | ||
| all_results.append(r.address) | ||
|
|
||
| result["objects"] = all_results | ||
| self.exit_json(**result) | ||
|
|
||
|
|
||
| def main(): | ||
| # define available arguments/parameters a user can pass to the module | ||
| module_args = dict( | ||
| id=dict(type="str", required=True), | ||
| cidr=dict(type="int", required=True), | ||
| count=dict(type="int", required=False), | ||
| ) | ||
|
|
||
| module = NextAvailableAddressBlockInfoModule( | ||
| argument_spec=module_args, | ||
| supports_check_mode=True, | ||
| ) | ||
| module.run_command() | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| dependencies: [setup_ip_space] |
Oops, something went wrong.