b71a62283c
* Initial version of aos_ip_pool module * Add examples for IP Pool * Break down ip_pool into smaller function * Refactor do_load_resource * Add get_display_name_from_file * Add ‘src’ as an option to load ip pool from JSON file * Rename directory network/apstra to network/aos * Remove exception handling temporary * Remove all ‘Exception as XX’ to be python 2.4 compatible * Replace ‘== False’ with ‘is False’ for PEP8 Test * Update documentation to be Yaml compatible * Lisg all method imported from module_utils.aos * Refactor to align with collection.find() changes * Update examples by @gundalow’s recommendations * Update Documentation per @gundalow’s recommendations * Change the license per @gundalow recommendation * Add exception handling for get_aos_session * Change Auth format and add check_aos_version() to check minimum version * Add a check for minimum version * Refactor ‘src’ into ‘content’ to allow more options Remove get_display_name_from_file in aos.py Add content_to_dict in aos.py * Fix variable name in do_load_resource * Add mention of aos.py in module_utilities doc * Add try/except for import yaml * Add try/Except around main block of code and function * Refactor to auto detect content_format, update doc accordingly * Change create_new_ip_pool inputs * Remove unused import * Remove in_use as it’s never used * Fix doc format * Add version number in requirement doc
49 lines
3.7 KiB
ReStructuredText
49 lines
3.7 KiB
ReStructuredText
Appendix: Module Utilities
|
|
``````````````````````````
|
|
|
|
Ansible provides a number of module utilities that provide helper functions that you can use when developing your own modules. The `basic.py` module utility provides the main entry point for accessing the Ansible library, and all Ansible modules must, at minimum, import from basic.py::
|
|
|
|
from ansible.module_utils.basic import *
|
|
|
|
|
|
The following is a list of module_utils files and a general description. The module utility source code lives in the `./lib/module_utils` directory under your main Ansible path - for more details on any specific module utility, please see the source code.
|
|
|
|
- a10.py - Utilities used by the a10_server module to manage A10 Networks devices.
|
|
- api.py - Adds shared support for generic API modules.
|
|
- aos.py - Module support utilities for managing Apstra AOS Server.
|
|
- asa.py - Module support utilities for managing Cisco ASA network devices.
|
|
- azure_rm_common.py - Definitions and utilities for Microsoft Azure Resource Manager template deployments.
|
|
- basic.py - General definitions and helper utilities for Ansible modules.
|
|
- cloudstack.py - Utilities for CloudStack modules.
|
|
- database.py - Miscellaneous helper functions for PostGRES and MySQL
|
|
- docker_common.py - Definitions and helper utilities for modules working with Docker.
|
|
- ec2.py - Definitions and utilities for modules working with Amazon EC2
|
|
- eos.py - Helper functions for modules working with EOS networking devices.
|
|
- f5.py - Helper functions for modules working with F5 networking devices.
|
|
- facts.py - Helper functions for modules that return facts.
|
|
- gce.py - Definitions and helper functions for modules that work with Google Compute Engine resources.
|
|
- ios.py - Definitions and helper functions for modules that manage Cisco IOS networking devices
|
|
- iosxr.py - Definitions and helper functions for modules that manage Cisco IOS-XR networking devices
|
|
- ismount.py - Contains single helper function that fixes os.path.ismount
|
|
- junos.py - Definitions and helper functions for modules that manage Junos networking devices
|
|
- known_hosts.py - utilities for working with known_hosts file
|
|
- mysql.py - Allows modules to connect to a MySQL instance
|
|
- netapp.py - Functions and utilities for modules that work with the NetApp storage platforms.
|
|
- netcfg.py - Configuration utility functions for use by networking modules
|
|
- netcmd.py - Defines commands and comparison operators for use in networking modules
|
|
- network.py - Functions for running commands on networking devices
|
|
- nxos.py - Contains definitions and helper functions specific to Cisco NXOS networking devices
|
|
- openstack.py - Utilities for modules that work with Openstack instances.
|
|
- openswitch.py - Definitions and helper functions for modules that manage OpenSwitch devices
|
|
- powershell.ps1 - Utilities for working with Microsoft Windows clients
|
|
- pycompat24.py - Exception workaround for python 2.4
|
|
- rax.py - Definitions and helper functions for modules that work with Rackspace resources.
|
|
- redhat.py - Functions for modules that manage Red Hat Network registration and subscriptions
|
|
- service.py - Contains utilities to enable modules to work with Linux services (placeholder, not in use).
|
|
- shell.py - Functions to allow modules to create shells and work with shell commands
|
|
- six.py - Module utils for working with the Six python 2 and 3 compatibility library
|
|
- splitter.py - String splitting and manipulation utilities for working with Jinja2 templates
|
|
- urls.py - Utilities for working with http and https requests
|
|
- vca.py - Contains utilities for modules that work with VMware vCloud Air
|
|
- vmware.py - Contains utilities for modules that work with VMware vSphere VMs
|
|
- vyos.py - Definitions and functions for working with VyOS networking
|