cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite/rst/dev_guide/developing_module_utilities.rst

55 lines
4.2 KiB
ReStructuredText
Raw Normal View History

Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
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.
New module aireos_command (#26769) * Adding ciscowlc_command module and unit tests. * Adding __init__.py for unit test. * Fixing PEP8 W503. * Renaming module from ciscowlc_command to aire_command. * Renaming aire_command to aireos_command.
2017-07-19 19:44:52 +02:00
- aireos.py - Definitions and helper functions for modules that manage Cisco WLC devices.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- api.py - Adds shared support for generic API modules.
New Module : aos_ip_pool as part of network/aos (#21044) * 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
2017-02-09 23:22:56 +01:00
- aos.py - Module support utilities for managing Apstra AOS Server.
Adding aruba_command module along with unit tests. (#26625) * Adding aruba_command module along with unit tests. * Fixing PEP8 E303 too many blank lines. * Adding default for timeout. * Removing unused arguments. Moving default for timeout argument. Fixing cliconf to find hostname. * Fixing PEP8 E302.
2017-07-19 06:19:12 +02:00
- aruba.py - Helper functions for modules working with Aruba networking devices.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- 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.
minor spelling changes
2016-12-11 03:50:09 +01:00
- basic.py - General definitions and helper utilities for Ansible modules.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- cloudstack.py - Utilities for CloudStack modules.
- database.py - Miscellaneous helper functions for PostGRES and MySQL
minor spelling changes
2016-12-11 03:50:09 +01:00
- docker_common.py - Definitions and helper utilities for modules working with Docker.
- ec2.py - Definitions and utilities for modules working with Amazon EC2
New Module : aos_ip_pool as part of network/aos (#21044) * 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
2017-02-09 23:22:56 +01:00
- eos.py - Helper functions for modules working with EOS networking devices.
- f5.py - Helper functions for modules working with F5 networking devices.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- 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
minor spelling changes
2016-12-11 03:50:09 +01:00
- known_hosts.py - utilities for working with known_hosts file
New model manageiq manageiq user (#26641) * ManageIQ: manageiq_user module, module utils and doc_fragment ManageIQ is an open source management platform for Hybrid IT. This change is adding: - manageiq_user module, responsible for user management in ManageIQ - manageiq utils - manageiq doc_fragment * Handle import error * Use formatting options * group parameter is required * changed doesn't need to be an attribute * resource dictionary should contain values which isn't None * move from monitoring to remote-management * Use ManageIQ nameing convention * Do not set defauts in arguments * Use idempotent state parameter instead of action * Check import error in the manageiq util class * Update the miq documentation * rename the connection configuration from miq to manageiq_connection * All messeges start with non cap, fix typos, add examples, rename vars * more typos fixes * Make sure we insert only strings to logs by using % formating * use suboptions keyword for the manageiq connection * do not log the managiq connection struct (it include sensitive information like username and password) * add missing from __future__ * ahh, wrong no-log line * Use sub options
2017-08-03 16:49:47 +02:00
- manageiq.py - Functions and utilities for modules that work with ManageIQ platform and its resources.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- mysql.py - Allows modules to connect to a MySQL instance
Add doc_fragment and module util for NetApp platforms (#19607) * Add doc_fragment and module util for NetApp platforms * Make requested changes * Fix links and change formatting. * Fix description sections.
2017-01-25 10:51:57 +01:00
- netapp.py - Functions and utilities for modules that work with the NetApp storage platforms.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- netcfg.py - Configuration utility functions for use by networking modules
- netcmd.py - Defines commands and comparison operators for use in networking modules
New module: manage Citrix Netscaler service configuration (network/netscaler/netscaler_service) (#25129) * netscaler_service initial implementation * Changes as requested by reviewers * Skip some tests if under python2.6 and importing requests library * Change option "operation" to "state" * Remove print statements from netscaler module utils * Catch all exceptions during login * Fix fail message * Add common option save_config
2017-06-08 16:33:32 +02:00
- netscaler.py - Utilities specifically for the netscaler network modules.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- 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
Initial commit for Pure Storage Ansible module (#25386) * Initial commit for Pure Storage Ansible module * Initial commit for Pure Storage Ansible module * Initial commit for Pure Storage Ansible module * Fix import issues as required by post-2.2 * Move last import to top * Follow suggestions and only implement one module per PR Fix documentation changes requested * Documentation and formatting changes
2017-06-16 12:28:50 +02:00
- pure.py - Functions and utilities for modules that work with the Pure Storage storage platforms.
[WIP] Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5 (#22721) * Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5 * Switched to bullet points to enhance readability.
2017-03-17 02:49:29 +01:00
- pycompat24.py - Exception workaround for Python 2.4.
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- 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
Update module_utils.six to latest (#22855) * Update module_utils.six to latest We've been held back on the version of six we could use on the module side to 1.4.x because of python-2.4 compatibility. Now that our minimum is Python-2.6, we can update to the latest version of six in module_utils and get rid of the second copy in lib/ansible/compat.
2017-03-23 21:35:05 +01:00
- six/__init__.py - Bundled copy of the `Six Python library <https://pythonhosted.org/six/>`_ to aid in writing code compatible with both Python 2 and Python 3.
minor spelling changes
2016-12-11 03:50:09 +01:00
- splitter.py - String splitting and manipulation utilities for working with Jinja2 templates
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- urls.py - Utilities for working with http and https requests
New Module : aos_ip_pool as part of network/aos (#21044) * 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
2017-02-09 23:22:56 +01:00
- vca.py - Contains utilities for modules that work with VMware vCloud Air
Dev guide reorg continues (#17732)
2016-09-23 22:48:37 +02:00
- vmware.py - Contains utilities for modules that work with VMware vSphere VMs
- vyos.py - Definitions and functions for working with VyOS networking
Reference in a new issue Copy permalink