ansible.module_utils package¶
Submodules¶
ansible.module_utils.a10 module¶
-
ansible.module_utils.a10.axapi_call(module, url, post=None)[source]¶ Returns a datastructure based on the result of the API call
ansible.module_utils.api module¶
This module adds shared support for generic api modules.
In order to use this module, include it as part of a custom module as shown below.
** Note: The order of the import statements does matter. **
from ansible.module_utils.basic import *
from ansible.module_utils.api import *
The ‘api’ module provides the following common argument specs:
rate limit spec
- rate: number of requests per time unit (int)
- rate_limit: time window in which the limit is applied in seconds
retry spec
- retries: number of attempts
- retry_pause: delay between attempts in seconds
-
ansible.module_utils.api.rate_limit_argument_spec(spec=None)[source]¶ Creates an argument spec for working with rate limiting
ansible.module_utils.azure_rm_common module¶
-
class
ansible.module_utils.azure_rm_common.AzureRMModuleBase(derived_arg_spec, bypass_checks=False, no_log=False, check_invalid_arguments=True, mutually_exclusive=None, required_together=None, required_one_of=None, add_file_common_args=False, supports_check_mode=False, required_if=None, supports_tags=True, facts_module=False)[source]¶ Bases:
object-
fail(msg, **kwargs)[source]¶ Shortcut for calling module.fail()
Parameters: - msg – Error message text.
- kwargs – Any key=value pairs
Returns: None
Check if tags dictionary contains string:string pairs.
Parameters: tags – dictionary of string:string pairs Returns: None
Call from the module to update metadata tags. Returns tuple with bool indicating if there was a change and dict of new tags to assign to the object.
Parameters: tags – metadata tags from the object Returns: bool, dict
Used in fact modules to compare object tags to list of parameter tags. Return true if list of parameter tags exists in object tags.
Parameters: - obj_tags – dictionary of tags from an Azure object.
- tag_list – list of tag keys or tag key:value pairs
Returns: bool
-
get_resource_group(resource_group)[source]¶ Fetch a resource group.
Parameters: resource_group – name of a resource group Returns: resource group object
-
serialize_obj(obj, class_name)[source]¶ Return a JSON representation of an Azure object.
Parameters: - obj – Azure object
- class_name – Name of the object’s class
Returns: serialized result
-
get_poller_result(poller, wait=5)[source]¶ Consistent method of waiting on and retrieving results from Azure’s long poller.
Parameters: - poller – Azure poller object
- wait (integer) – How long to wait.
Returns: object resulting from the original request
-
check_provisioning_state(azure_object, requested_state='present')[source]¶ Check an Azure object’s provisioning state.
If something did not complete the provisioning process, then we cannot operate on it.
Parameters: azure_object – An object such as a subnet, storageaccount, etc. Must have provisioning_state and name attributes. :return None
-
create_default_pip(resource_group, location, name, allocation_method='Dynamic')[source]¶ Create a default public IP address <name>01 to associate with a network interface. If a PIP address matching <vm name>01 exists, return it. Otherwise, create one.
Parameters: - resource_group – name of an existing resource group
- location – a valid azure location
- name – base name to assign the public IP address
- allocation_method – one of ‘Static’ or ‘Dynamic’
Returns: PIP object
-
create_default_securitygroup(resource_group, location, name, os_type, open_ports)[source]¶ Create a default security group :name: to associate with a network interface.
If a security group matching :name: exists, return it. Otherwise, create one.
Parameters: - resource_group – Resource group name
- location – azure location name
- name – base name to use for the security group
- os_type – one of ‘Windows’ or ‘Linux’. Determins any default rules added to the security group.
- open_ports (list of integers) – list of network ports to open
Returns: security_group object
-
storage_client¶
-
network_client¶
-
rm_client¶
-
compute_client¶
-
ansible.module_utils.basic module¶
-
ansible.module_utils.basic.get_platform()[source]¶ Get the systems platform or OS name.
For example: ‘Linux’, ‘Windows’ or ‘Java’.
Returns: The name of the platform as a string. An empty string is returned if the value cannot be determined.
-
ansible.module_utils.basic.get_distribution()[source]¶ Get the systems distribution name if applicable.
Possible results include: ‘Amazon’, ‘SuSE’, ‘UnitedLinux’, ‘arch’, ‘centos’, ‘debian’, ‘fedora’, ‘gentoo’, ‘mandrake’, ‘mandriva’, ‘redhat’, ‘rocks’, ‘slackware’, ‘turbolinux’, ‘yellowdog’, ‘OtherLinux’
Returns: The name of the distribution as a string. If system is linux, but no known distribution is detected ‘OtherLinux’ is returned.
-
ansible.module_utils.basic.get_distribution_version()[source]¶ Get the linux distribution version, if applicable.
Returns: A string or None. If the system is linux, the distribution version number is returned as a string. If system is not linux, None is returned.
-
ansible.module_utils.basic.get_all_subclasses(cls)[source]¶ Get a list of all class objects that subclass :cls:.
Used by modules like :Hardware: or :Network: fact classes to retrieve all subclasses of a given class. __subclasses__() only returns direct subclasses. get_all_subclasses() goes down into the class tree.
Returns: class: objects. Return type: A list of
-
ansible.module_utils.basic.load_platform_subclass(cls, *args, **kwargs)[source]¶ used by modules like User to have different implementations based on detected platform. See User module for an example.
-
ansible.module_utils.basic.json_dict_unicode_to_bytes(d, encoding='utf-8')[source]¶ Recursively convert dict keys and values to byte str
Specialized for json return because this only handles, lists, tuples, and dict container types (the containers that the json module returns)
-
ansible.module_utils.basic.json_dict_bytes_to_unicode(d, encoding='utf-8')[source]¶ Recursively convert dict keys and values to byte str
Specialized for json return because this only handles, lists, tuples, and dict container types (the containers that the json module returns)
-
ansible.module_utils.basic.return_values(obj)[source]¶ Return stringified values from datastructures. For use with removing sensitive values pre-jsonification.
-
ansible.module_utils.basic.remove_values(value, no_log_strings)[source]¶ Remove strings in no_log_strings from value. If value is a container type, then remove a lot more
-
ansible.module_utils.basic.heuristic_log_sanitize(data, no_log_values=None)[source]¶ Remove strings that look like passwords from log messages
-
ansible.module_utils.basic.is_executable(path)[source]¶ Determine if the given :path: is executable.
Limitations:
* Does not account for FSACLs. * Most times we really want to know "Can the current user execute this file" This function does not tell us that, only if an execute bit is set.
-
class
ansible.module_utils.basic.AnsibleModule(argument_spec, bypass_checks=False, no_log=False, check_invalid_arguments=True, mutually_exclusive=None, required_together=None, required_one_of=None, add_file_common_args=False, supports_check_mode=False, required_if=None)[source]¶ Bases:
object-
load_file_common_arguments(params)[source]¶ many modules deal with files, this encapsulates common options that the file module accepts such that it is directly available to all modules and they can share code.
-
is_special_selinux_path(path)[source]¶ Returns a tuple containing (True, selinux_context) if the given path is on a NFS or other ‘special’ fs mount point, otherwise the return will be (False, None).
-
add_path_info(kwargs)[source]¶ for results that are files, supplement the info about the file in the return path with stats about the file path.
-
get_bin_path(arg, required=False, opt_dirs=[])[source]¶ Find system executable in
PATH.- Arg:
- required (bool): if executable is not found and required is true, :fail_json:
opt_dirs (list): optional list of directories to search in addition to
PATH
Returns: arg: is found return full path; otherwise return None. Return type: if
-
fail_on_missing_params(required_params=None)[source]¶ This is for checking for required params when we can not check via argspec because we need more information than is simply given in the argspec.
-
digest_from_file(filename, algorithm)[source]¶ Return hex digest of local file for a digest_method specified by name, or None if file is not present.
-
md5(filename)[source]¶ Return MD5 hex digest of local file using digest_from_file().
- Do not use this function unless you have no other choice for:
- Optional backwards compatibility
- Compatibility with a third party protocol
This function will not work on systems complying with FIPS-140-2.
Most uses of this function can use the module.sha1 function instead.
-
backup_local(fn)[source]¶ make a date-marked backup of the specified file, return True or False on success or failure
-
atomic_move(src, dest, unsafe_writes=False)[source]¶ atomically move src to dest, copying attributes from dest, returns true on success it uses os.rename to ensure this as it is an atomic operation, rest of the function is to work around limitations, corner cases and ensure selinux context is saved if possible
-
run_command(args, check_rc=False, close_fds=True, executable=None, data=None, binary_data=False, path_prefix=None, cwd=None, use_unsafe_shell=False, prompt_regex=None, environ_update=None)[source]¶ Execute a command, returns rc, stdout, and stderr.
Parameters: - args – is the command to run * If args is a list, the command will be run with shell=False. * If args is a string and use_unsafe_shell=False it will split args to a list and run with shell=False * If args is a string and use_unsafe_shell=True it runs with shell=True.
- environ_update – dictionary to update os.environ with
Kw check_rc: Whether to call fail_json in case of non zero RC. Default False
Kw close_fds: See documentation for subprocess.Popen(). Default True
Kw executable: See documentation for subprocess.Popen(). Default None
Kw data: If given, information to write to the stdin of the command
Kw binary_data: If False, append a newline to the data. Default False
Kw path_prefix: If given, additional path to find the command in. This adds to the PATH environment vairable so helper commands in the same directory can also be found
Kw cwd: iIf given, working directory to run the command inside
Kw use_unsafe_shell: See args parameter. Default False
Kw prompt_regex: Regex string (not a compiled regex) which can be used to detect prompts in the stdout which would otherwise cause the execution to hang (especially if no input data is specified)
-
is_executable(path)¶ Determine if the given :path: is executable.
Limitations:
* Does not account for FSACLs. * Most times we really want to know "Can the current user execute this file" This function does not tell us that, only if an execute bit is set.
-
ansible.module_utils.cloudstack module¶
ansible.module_utils.database module¶
ansible.module_utils.docker_common module¶
-
class
ansible.module_utils.docker_common.AnsibleDockerClient(argument_spec=None, supports_check_mode=False, mutually_exclusive=None, required_together=None, required_if=None)[source]¶ Bases:
ansible.module_utils.docker_common.Client-
auth_params¶
-
ansible.module_utils.ec2 module¶
-
ansible.module_utils.ec2.boto3_conn(module, conn_type=None, resource=None, region=None, endpoint=None, **params)[source]¶
-
ansible.module_utils.ec2.get_ec2_creds(module)[source]¶ for compatibility mode with old modules that don’t/can’t yet use ec2_connect method
-
ansible.module_utils.ec2.boto_fix_security_token_in_profile(conn, profile_name)[source]¶ monkey patch for boto issue boto/boto#2100
-
ansible.module_utils.ec2.paging(pause=0, marker_property='marker')[source]¶ Adds paging to boto retrieval functions that support a ‘marker’ this is configurable as not all boto functions seem to use the same name.
-
ansible.module_utils.ec2.ansible_dict_to_boto3_filter_list(filters_dict)[source]¶ Convert :filters_dict: (an Ansible dict of filters) to a list of dicts that :boto3: can use.
Parameters: filters_dict (dict) – Dict of AWS filters. Basic Usage:
>>> filters = {'some-aws-id', 'i-01234567'} >>> ansible_dict_to_boto3_filter_list(filters) { 'some-aws-id': 'i-01234567' }
Returns: List of AWS filters and their values [
- {
- ‘Name’: ‘some-aws-id’,
‘Values’: [‘i-01234567’,
]
}
]
Return type: List
-
ansible.module_utils.ec2.boto3_tag_list_to_ansible_dict(tags_list)[source]¶ Convert a boto3 list of resource tags to a flat dict of key:value pairs :param tags_list: List of dicts representing AWS tags. :type tags_list: list
- Basic Usage:
>>> tags_list = [{'Key': 'MyTagKey', 'Value': 'MyTagValue'}] >>> boto3_tag_list_to_ansible_dict(tags_list) [ { 'Key': 'MyTagKey', 'Value': 'MyTagValue' } ]
Returns: - Dict of key:value pairs representing AWS tags
- {
- ‘MyTagKey’: ‘MyTagValue’,
}
Return type: Dict
-
ansible.module_utils.ec2.ansible_dict_to_boto3_tag_list(tags_dict)[source]¶ Convert a flat dict of key:value pairs representing AWS resource tags to a boto3 list of dicts :param tags_dict: Dict representing AWS resource tags. :type tags_dict: dict
- Basic Usage:
>>> tags_dict = {'MyTagKey': 'MyTagValue'} >>> ansible_dict_to_boto3_tag_list(tags_dict) { 'MyTagKey': 'MyTagValue' }
Returns: List of dicts containing tag keys and values [ - {
- ‘Key’: ‘MyTagKey’, ‘Value’: ‘MyTagValue’
}
]
Return type: List
-
ansible.module_utils.ec2.get_ec2_security_group_ids_from_names(sec_group_list, ec2_connection, vpc_id=None, boto3=True)[source]¶ Return list of security group IDs from security group names. Note that security group names are not unique across VPCs. If a name exists across multiple VPCs and no VPC ID is supplied, all matching IDs will be returned. This will probably lead to a boto exception if you attempt to assign both IDs to a resource so ensure you wrap the call in a try block
ansible.module_utils.eos module¶
-
class
ansible.module_utils.eos.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
connected¶
-
config¶
-
ansible.module_utils.f5 module¶
ansible.module_utils.facts module¶
-
class
ansible.module_utils.facts.Facts(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
objectThis class should only attempt to populate those facts that are mostly generic to all systems. This includes platform facts, service facts (e.g. ssh keys or selinux), and distribution facts. Anything that requires extensive code or may have more than one possible implementation to establish facts for a given topic should subclass Facts.
-
SELINUX_MODE_DICT= {0: 'permissive', 1: 'enforcing', -1: 'disabled'}¶
-
PKG_MGRS= [{'path': '/usr/bin/yum', 'name': 'yum'}, {'path': '/usr/bin/dnf', 'name': 'dnf'}, {'path': '/usr/bin/apt-get', 'name': 'apt'}, {'path': '/usr/bin/zypper', 'name': 'zypper'}, {'path': '/usr/sbin/urpmi', 'name': 'urpmi'}, {'path': '/usr/bin/pacman', 'name': 'pacman'}, {'path': '/bin/opkg', 'name': 'opkg'}, {'path': '/usr/pkg/bin/pkgin', 'name': 'pkgin'}, {'path': '/opt/local/bin/pkgin', 'name': 'pkgin'}, {'path': '/opt/local/bin/port', 'name': 'macports'}, {'path': '/usr/local/bin/brew', 'name': 'homebrew'}, {'path': '/sbin/apk', 'name': 'apk'}, {'path': '/usr/sbin/pkg', 'name': 'pkgng'}, {'path': '/usr/sbin/swlist', 'name': 'SD-UX'}, {'path': '/usr/bin/emerge', 'name': 'portage'}, {'path': '/usr/sbin/pkgadd', 'name': 'svr4pkg'}, {'path': '/usr/bin/pkg', 'name': 'pkg'}, {'path': '/usr/bin/xbps-install', 'name': 'xbps'}, {'path': '/usr/local/sbin/pkg', 'name': 'pkgng'}]¶
-
-
class
ansible.module_utils.facts.Distribution(module)[source]¶ Bases:
objectThis subclass of Facts fills the distribution, distribution_version and distribution_release variables
To do so it checks the existance and content of typical files in /etc containing distribution information
This is unit tested. Please extend the tests to cover all distributions if you have them available.
-
OSDIST_LIST= ({'path': '/etc/oracle-release', 'name': 'OracleLinux'}, {'path': '/etc/slackware-version', 'name': 'Slackware'}, {'path': '/etc/redhat-release', 'name': 'RedHat'}, {'path': '/etc/vmware-release', 'allowempty': True, 'name': 'VMwareESX'}, {'path': '/etc/openwrt_release', 'name': 'OpenWrt'}, {'path': '/etc/system-release', 'name': 'Amazon'}, {'path': '/etc/alpine-release', 'name': 'Alpine'}, {'path': '/etc/release', 'name': 'Solaris'}, {'path': '/etc/arch-release', 'allowempty': True, 'name': 'Archlinux'}, {'path': '/etc/os-release', 'name': 'SuSE'}, {'path': '/etc/SuSE-release', 'name': 'SuSE'}, {'path': '/etc/gentoo-release', 'name': 'Gentoo'}, {'path': '/etc/os-release', 'name': 'Debian'}, {'path': '/etc/lsb-release', 'name': 'Mandriva'}, {'path': '/etc/altlinux-release', 'name': 'Altlinux'}, {'path': '/etc/os-release', 'name': 'NA'}, {'path': '/etc/coreos/update.conf', 'name': 'Coreos'})¶
-
SEARCH_STRING= {'Altlinux': 'ALT Linux', 'OracleLinux': 'Oracle Linux', 'RedHat': 'Red Hat'}¶
-
OS_FAMILY= {'Altlinux': 'Altlinux', 'AIX': 'AIX', 'MacOSX': 'Darwin', 'Archlinux': 'Archlinux', 'Slackware': 'Slackware', 'OracleLinux': 'RedHat', 'Fedora': 'RedHat', 'SuSE': 'Suse', 'Scientific': 'RedHat', 'Gentoo': 'Gentoo', 'OmniOS': 'Solaris', 'Funtoo': 'Gentoo', 'openSUSE_Leap': 'Suse', 'XenServer': 'RedHat', 'Amazon': 'RedHat', 'FreeBSD': 'FreeBSD', 'Mandrake': 'Mandrake', 'Raspbian': 'Debian', 'Debian': 'Debian', 'Alpine': 'Alpine', 'RedHat': 'RedHat', 'Manjaro': 'Archlinux', 'PSBM': 'RedHat', 'CloudLinux': 'RedHat', 'Ubuntu': 'Debian', 'SmartOS': 'Solaris', 'openSUSE': 'Suse', 'SLED': 'Suse', 'Mandriva': 'Mandrake', 'SLES': 'Suse', 'Nexenta': 'Solaris', 'SLC': 'RedHat', 'Ascendos': 'RedHat', 'OVS': 'RedHat', 'Solaris': 'Solaris', 'CentOS': 'RedHat', 'OpenIndiana': 'Solaris', 'OEL': 'RedHat', 'SLES_SAP': 'Suse', 'HPUX': 'HP-UX'}¶
-
-
class
ansible.module_utils.facts.Hardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.FactsThis is a generic Hardware subclass of Facts. This should be further subclassed to implement per platform. If you subclass this, it should define: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count
All subclasses MUST define platform.
-
platform= 'Generic'¶
-
-
class
ansible.module_utils.facts.LinuxHardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareLinux-specific subclass of Hardware. Defines memory and CPU facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count
In addition, it also defines number of DMI facts and device facts.
-
platform= 'Linux'¶
-
ORIGINAL_MEMORY_FACTS= frozenset(['SwapTotal', 'MemFree', 'MemTotal', 'SwapFree'])¶
-
MEMORY_FACTS= frozenset(['MemTotal', 'SwapTotal', 'SwapCached', 'SwapFree', 'Cached', 'MemFree', 'Buffers'])¶
-
-
class
ansible.module_utils.facts.SunOSHardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareIn addition to the generic memory and cpu facts, this also sets swap_reserved_mb and swap_allocated_mb that is available from swap -s.
-
platform= 'SunOS'¶
-
-
class
ansible.module_utils.facts.OpenBSDHardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareOpenBSD-specific subclass of Hardware. Defines memory, CPU and device facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count - processor_speed - devices
-
platform= 'OpenBSD'¶
-
DMESG_BOOT= '/var/run/dmesg.boot'¶
-
-
class
ansible.module_utils.facts.FreeBSDHardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareFreeBSD-specific subclass of Hardware. Defines memory and CPU facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count - devices
-
platform= 'FreeBSD'¶
-
DMESG_BOOT= '/var/run/dmesg.boot'¶
-
-
class
ansible.module_utils.facts.DragonFlyHardware(module, load_on_init=True, cached_facts=None)[source]¶
-
class
ansible.module_utils.facts.NetBSDHardware(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareNetBSD-specific subclass of Hardware. Defines memory and CPU facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count - devices
-
platform= 'NetBSD'¶
-
MEMORY_FACTS= ['MemTotal', 'SwapTotal', 'MemFree', 'SwapFree']¶
-
-
class
ansible.module_utils.facts.AIX(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareAIX-specific subclass of Hardware. Defines memory and CPU facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor (a list) - processor_cores - processor_count
-
platform= 'AIX'¶
-
-
class
ansible.module_utils.facts.HPUX(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareHP-UX-specific subclass of Hardware. Defines memory and CPU facts: - memfree_mb - memtotal_mb - swapfree_mb - swaptotal_mb - processor - processor_cores - processor_count - model - firmware
-
platform= 'HP-UX'¶
-
-
class
ansible.module_utils.facts.Darwin(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.HardwareDarwin-specific subclass of Hardware. Defines memory and CPU facts: - processor - processor_cores - memtotal_mb - memfree_mb - model - osversion - osrevision
-
platform= 'Darwin'¶
-
-
class
ansible.module_utils.facts.Network(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.FactsThis is a generic Network subclass of Facts. This should be further subclassed to implement per platform. If you subclass this, you must define: - interfaces (a list of interface names) - interface_<name> dictionary of ipv4, ipv6, and mac address information.
All subclasses MUST define platform.
-
platform= 'Generic'¶
-
IPV6_SCOPE= {'10': 'host', '20': 'link', '50': 'site', '40': 'admin', '0': 'global', '80': 'organization'}¶
-
-
class
ansible.module_utils.facts.LinuxNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.NetworkThis is a Linux-specific subclass of Network. It defines - interfaces (a list of interface names) - interface_<name> dictionary of ipv4, ipv6, and mac address information. - all_ipv4_addresses and all_ipv6_addresses: lists of all configured addresses. - ipv4_address and ipv6_address: the first non-local address for each family.
-
platform= 'Linux'¶
-
-
class
ansible.module_utils.facts.GenericBsdIfconfigNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.NetworkThis is a generic BSD subclass of Network using the ifconfig command. It defines - interfaces (a list of interface names) - interface_<name> dictionary of ipv4, ipv6, and mac address information. - all_ipv4_addresses and all_ipv6_addresses: lists of all configured addresses. It currently does not define - default_ipv4 and default_ipv6 - type, mtu and network on interfaces
-
platform= 'Generic_BSD_Ifconfig'¶
-
-
class
ansible.module_utils.facts.HPUXNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.NetworkHP-UX-specifig subclass of Network. Defines networking facts: - default_interface - interfaces (a list of interface names) - interface_<name> dictionary of ipv4 address information.
-
platform= 'HP-UX'¶
-
-
class
ansible.module_utils.facts.DarwinNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the Mac OS X/Darwin Network Class. It uses the GenericBsdIfconfigNetwork unchanged
-
platform= 'Darwin'¶
-
-
class
ansible.module_utils.facts.FreeBSDNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the FreeBSD Network Class. It uses the GenericBsdIfconfigNetwork unchanged.
-
platform= 'FreeBSD'¶
-
-
class
ansible.module_utils.facts.DragonFlyNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the DragonFly Network Class. It uses the GenericBsdIfconfigNetwork unchanged.
-
platform= 'DragonFly'¶
-
-
class
ansible.module_utils.facts.AIXNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the AIX Network Class. It uses the GenericBsdIfconfigNetwork unchanged.
-
platform= 'AIX'¶
-
-
class
ansible.module_utils.facts.OpenBSDNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the OpenBSD Network Class. It uses the GenericBsdIfconfigNetwork.
-
platform= 'OpenBSD'¶
-
-
class
ansible.module_utils.facts.SunOSNetwork(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.GenericBsdIfconfigNetworkThis is the SunOS Network Class. It uses the GenericBsdIfconfigNetwork.
Solaris can have different FLAGS and MTU for IPv4 and IPv6 on the same interface so these facts have been moved inside the ‘ipv4’ and ‘ipv6’ lists.
-
platform= 'SunOS'¶
-
-
class
ansible.module_utils.facts.Virtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.FactsThis is a generic Virtual subclass of Facts. This should be further subclassed to implement per platform. If you subclass this, you should define: - virtualization_type - virtualization_role - container (e.g. solaris zones, freebsd jails, linux containers)
All subclasses MUST define platform.
-
class
ansible.module_utils.facts.LinuxVirtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.VirtualThis is a Linux-specific subclass of Virtual. It defines - virtualization_type - virtualization_role
-
platform= 'Linux'¶
-
-
class
ansible.module_utils.facts.FreeBSDVirtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.VirtualThis is a FreeBSD-specific subclass of Virtual. It defines - virtualization_type - virtualization_role
-
platform= 'FreeBSD'¶
-
-
class
ansible.module_utils.facts.DragonFlyVirtual(module, load_on_init=True, cached_facts=None)[source]¶
-
class
ansible.module_utils.facts.OpenBSDVirtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.VirtualThis is a OpenBSD-specific subclass of Virtual. It defines - virtualization_type - virtualization_role
-
platform= 'OpenBSD'¶
-
-
class
ansible.module_utils.facts.HPUXVirtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.VirtualThis is a HP-UX specific subclass of Virtual. It defines - virtualization_type - virtualization_role
-
platform= 'HP-UX'¶
-
-
class
ansible.module_utils.facts.SunOSVirtual(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.VirtualThis is a SunOS-specific subclass of Virtual. It defines - virtualization_type - virtualization_role - container
-
platform= 'SunOS'¶
-
-
class
ansible.module_utils.facts.Ohai(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.FactsThis is a subclass of Facts for including information gathered from Ohai.
-
class
ansible.module_utils.facts.Facter(module, load_on_init=True, cached_facts=None)[source]¶ Bases:
ansible.module_utils.facts.FactsThis is a subclass of Facts for including information gathered from Facter.
ansible.module_utils.gce module¶
ansible.module_utils.ios module¶
-
class
ansible.module_utils.ios.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
connected¶
-
config¶
-
ansible.module_utils.iosxr module¶
-
class
ansible.module_utils.iosxr.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
connected¶
-
config¶
-
ansible.module_utils.ismount module¶
-
ansible.module_utils.ismount.ismount(path)[source]¶ Test whether a path is a mount point clone of os.path.ismount (from cpython Lib/posixpath.py) fixed to solve https://github.com/ansible/ansible-modules-core/issues/2186 and workaround non-fixed http://bugs.python.org/issue2466 this should be rewritten as soon as python issue 2466 is fixed probably check for python version and use os.path.ismount if fixed
to remove replace in this file ismount( -> os.path.ismount( and remove this function
ansible.module_utils.junos module¶
-
class
ansible.module_utils.junos.Netconf(module)[source]¶ Bases:
object
-
class
ansible.module_utils.junos.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
connected¶
-
ansible.module_utils.known_hosts module¶
ansible.module_utils.mysql module¶
ansible.module_utils.netcfg module¶
-
class
ansible.module_utils.netcfg.NetworkConfig(indent=None, contents=None, device_os=None)[source]¶ Bases:
object-
items¶
-
-
class
ansible.module_utils.netcfg.Conditional(conditional, encoding='json')[source]¶ Bases:
objectUsed in command modules to evaluate waitfor conditions
-
OPERATORS= {'le': ['le', '<='], 'contains': ['contains'], 'lt': ['lt', '<'], 'ge': ['ge', '>='], 'gt': ['gt', '>'], 'eq': ['eq', '=='], 'neq': ['neq', 'ne', '!=']}¶
-
ansible.module_utils.nxos module¶
-
class
ansible.module_utils.nxos.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
connected¶
-
config¶
-
ansible.module_utils.openstack module¶
ansible.module_utils.openswitch module¶
-
class
ansible.module_utils.openswitch.NetworkModule(*args, **kwargs)[source]¶ Bases:
ansible.module_utils.basic.AnsibleModule-
config¶
-
ansible.module_utils.pycompat24 module¶
-
ansible.module_utils.pycompat24.get_exception()[source]¶ Get the current exception.
This code needs to work on Python 2.4 through 3.x, so we cannot use “except Exception, e:” (SyntaxError on Python 3.x) nor “except Exception as e:” (SyntaxError on Python 2.4-2.5). Instead we must use
except Exception: e = get_exception()
ansible.module_utils.rax module¶
-
ansible.module_utils.rax.rax_slugify(value)[source]¶ Prepend a key with rax_ and normalize the key name
-
ansible.module_utils.rax.rax_clb_node_to_dict(obj)[source]¶ Function to convert a CLB Node object to a dict
-
ansible.module_utils.rax.rax_to_dict(obj, obj_type='standard')[source]¶ Generic function to convert a pyrax object to a dict
- obj_type values:
- standard clb server
-
ansible.module_utils.rax.rax_find_bootable_volume(module, rax_module, server, exit=True)[source]¶ Find a servers bootable volume
-
ansible.module_utils.rax.rax_find_image(module, rax_module, image, exit=True)[source]¶ Find a server image by ID or Name
-
ansible.module_utils.rax.rax_find_volume(module, rax_module, name)[source]¶ Find a Block storage volume by ID or name
-
ansible.module_utils.rax.rax_find_network(module, rax_module, network)[source]¶ Find a cloud network by ID or name
-
ansible.module_utils.rax.rax_find_server(module, rax_module, server)[source]¶ Find a Cloud Server by ID or name
-
ansible.module_utils.rax.rax_find_loadbalancer(module, rax_module, loadbalancer)[source]¶ Find a Cloud Load Balancer by ID or name
-
ansible.module_utils.rax.rax_argument_spec()[source]¶ Return standard base dictionary used for the argument_spec argument in AnsibleModule
ansible.module_utils.redhat module¶
-
class
ansible.module_utils.redhat.RegistrationBase(module, username=None, password=None)[source]¶ Bases:
object
-
class
ansible.module_utils.redhat.Rhsm(module, username=None, password=None)[source]¶ Bases:
ansible.module_utils.redhat.RegistrationBase-
enable()[source]¶ Enable the system to receive updates from subscription-manager. This involves updating affected yum plugins and removing any conflicting yum repositories.
-
configure(**kwargs)[source]¶ Configure the system as directed for registration with RHN :raises: * Exception - if error occurs while running command
-
is_registered¶ Determine whether the current system is registered to :RHSM:.
Returns: Boolean - whether the current system is currently registered to RHSM.
-
register(username, password, autosubscribe, activationkey)[source]¶ Register the current system to the configured :RHSM: server.
Raises: Exception - if error occurs while running command subscription-manager register
-
unsubscribe()[source]¶ Unsubscribe a system from all subscribed channels :raises: * Exception - if error occurs while running command
-
ansible.module_utils.service module¶
-
class
ansible.module_utils.service.Service(module)[source]¶ Bases:
objectThis is the generic Service manipulation class that is subclassed based on system.
- A subclass should override the following methods:
- action
- enable
- status
ansible.module_utils.shell module¶
-
exception
ansible.module_utils.shell.ShellError(msg, command=None)[source]¶ Bases:
exceptions.Exception
-
class
ansible.module_utils.shell.Command(command, prompt=None, response=None)[source]¶ Bases:
object
ansible.module_utils.splitter module¶
-
ansible.module_utils.splitter.split_args(args)[source]¶ Splits args on whitespace, but intelligently reassembles those that may have been split over a jinja2 block or quotes.
When used in a remote module, we won’t ever have to be concerned about jinja2 blocks, however this function is/will be used in the core portions as well before the args are templated.
example input: a=b c=”foo bar” example output: [‘a=b’, ‘c=”foo bar”’]
Basically this is a variation shlex that has some more intelligence for how Ansible needs to use it.
ansible.module_utils.urls module¶
-
exception
ansible.module_utils.urls.ConnectionError[source]¶ Bases:
exceptions.ExceptionFailed to connect to the server
-
exception
ansible.module_utils.urls.ProxyError[source]¶ Bases:
ansible.module_utils.urls.ConnectionErrorFailure to connect because of a proxy
-
exception
ansible.module_utils.urls.SSLValidationError[source]¶ Bases:
ansible.module_utils.urls.ConnectionErrorFailure to connect due to SSL validation failing
-
exception
ansible.module_utils.urls.NoSSLError[source]¶ Bases:
ansible.module_utils.urls.SSLValidationErrorNeeded to connect to an HTTPS url but no ssl library available to verify the certificate
-
class
ansible.module_utils.urls.CustomHTTPSConnection(*args, **kwargs)[source]¶ Bases:
httplib.HTTPSConnection
-
class
ansible.module_utils.urls.CustomHTTPSHandler(debuglevel=0, context=None)[source]¶ Bases:
urllib2.HTTPSHandler-
https_request(request)¶
-
-
ansible.module_utils.urls.generic_urlparse(parts)[source]¶ Returns a dictionary of url parts as parsed by urlparse, but accounts for the fact that older versions of that library do not support named attributes (ie. .netloc)
-
class
ansible.module_utils.urls.RequestWithMethod(url, method, data=None, headers=None)[source]¶ Bases:
urllib2.RequestWorkaround for using DELETE/PUT/etc with urllib2 Originally contained in library/net_infrastructure/dnsmadeeasy
-
ansible.module_utils.urls.RedirectHandlerFactory(follow_redirects=None, validate_certs=True)[source]¶ This is a class factory that closes over the value of
follow_redirectsso that the RedirectHandler class has access to that value without having to use globals, and potentially cause problems whereopen_urlorfetch_urlare used multiple times in a module.
-
ansible.module_utils.urls.build_ssl_validation_error(hostname, port, paths)[source]¶ Inteligently build out the SSLValidationError based on what support you have installed
-
class
ansible.module_utils.urls.SSLValidationHandler(hostname, port)[source]¶ Bases:
urllib2.BaseHandlerA custom handler class for SSL validation.
Based on: http://stackoverflow.com/questions/1087227/validate-ssl-certificates-with-python http://techknack.net/python-urllib2-handlers/
-
CONNECT_COMMAND= 'CONNECT %s:%s HTTP/1.0\r\nConnection: close\r\n'¶
-
validate_proxy_response(response, valid_codes=[200])[source]¶ make sure we get back a valid code from the proxy
-
detect_no_proxy(url)[source]¶ Detect if the ‘no_proxy’ environment variable is set and honor those locations.
-
https_request(req)¶
-
-
ansible.module_utils.urls.open_url(url, data=None, headers=None, method=None, use_proxy=True, force=False, last_mod_time=None, timeout=10, validate_certs=True, url_username=None, url_password=None, http_agent=None, force_basic_auth=False, follow_redirects='urllib2')[source]¶ Fetches a file from an HTTP/FTP server using urllib2
Does not require the module environment