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 Subnet Support for Ansible V2 (infobloxopen#59)
* created a next_available_subnet * Added next available subnet functionality * created a setup_ip_space and setup_address_block seperately * refactor the next_available_subnet * fixed next_available_subnet * added required_by instead of required_together in ipam_subnet.py * added description and change example name * added description * Fixed sanity issues * changed Module_defaults --------- Co-authored-by: Ujjwal Nasra <125353741+unasra@users.noreply.github.com>
- Loading branch information
Showing
10 changed files
with
348 additions
and
115 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| #!/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_subnet_info | ||
| short_description: Retrieves the Next available subnet | ||
| description: | ||
| - Retrieves the Next Available Subnet in the specified Address Block | ||
| version_added: 2.0.0 | ||
| author: Infoblox Inc. (@infobloxopen) | ||
| options: | ||
| id: | ||
| description: | ||
| - An application specific resource identity of a resource | ||
| type: str | ||
| required: true | ||
| cidr: | ||
| description: | ||
| - The cidr value of address blocks to be created. | ||
| type: int | ||
| required: true | ||
| count: | ||
| description: | ||
| - Number of address blocks to generate. Default 1 if not set. | ||
| type: int | ||
| required: false | ||
| extends_documentation_fragment: | ||
| - infoblox.bloxone.common | ||
| """ # noqa: E501 | ||
|
|
||
| EXAMPLES = r""" | ||
| - name: "Create an IP Space (required as parent)" | ||
| infoblox.bloxone.ipam_ip_space: | ||
| name: "example-ipspace" | ||
| state: "present" | ||
| register: ip_space | ||
| - name: "Create an Address Block (required as parent)" | ||
| infoblox.bloxone.ipam_address_block: | ||
| address: "10.0.0.0/16" | ||
| space: "{{ ip_space.id }}" | ||
| state: "present" | ||
| register: address_block | ||
| - name: "Get information about the Subnet" | ||
| infoblox.bloxone.ipam_next_available_subnet_info: | ||
| id: "{{ address_block.id }}" | ||
| cidr: 24 | ||
| - name: "Get information about the Subnet with count" | ||
| infoblox.bloxone.ipam_next_available_subnet_info: | ||
| id: "{{ address_block.id }}" | ||
| cidr: 24 | ||
| count: 5 | ||
| """ | ||
|
|
||
| RETURN = r""" | ||
| id: | ||
| description: | ||
| - ID of the Subnet object | ||
| type: str | ||
| returned: Always | ||
| objects: | ||
| description: | ||
| - List of next available subnet addresses | ||
| type: list | ||
| elements: str | ||
| returned: Always | ||
| """ # noqa: E501 | ||
|
|
||
| from ansible_collections.infoblox.bloxone.plugins.module_utils.modules import BloxoneAnsibleModule | ||
|
|
||
| try: | ||
| from ipam import AddressBlockApi | ||
| from universal_ddi_client import ApiException | ||
| except ImportError: | ||
| pass # Handled by BloxoneAnsibleModule | ||
|
|
||
|
|
||
| class NextAvailableSubnetInfoModule(BloxoneAnsibleModule): | ||
| def __init__(self, *args, **kwargs): | ||
| super(NextAvailableSubnetInfoModule, 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_subnet( | ||
| 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 = NextAvailableSubnetInfoModule( | ||
| 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
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
2 changes: 2 additions & 0 deletions
2
tests/integration/targets/ipam_next_available_subnet_info/meta/main.yml
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, setup_address_block] |
Oops, something went wrong.