Ansible 参考：模块实用程序

本页记录在使用 Python 编写 Ansible 模块时有帮助的实用程序。

AnsibleModule

要使用此功能，请在模块中包含 from ansible.module_utils.basic import AnsibleModule。

class ansible.module_utils.basic.AnsibleModule(argument_spec, bypass_checks=False, no_log=False, mutually_exclusive=None, required_together=None, required_one_of=None, add_file_common_args=False, supports_check_mode=False, required_if=None, required_by=None)

在 Python 中快速构建 Ansible 模块的通用代码（尽管您可以使用任何可以返回 JSON 的内容编写模块）。

有关一般介绍，请参见开发模块，有关更详细的说明，请参见 Ansible 模块架构。

add_path_info(kwargs): 对于作为文件的返回结果，使用有关文件路径的统计信息来补充返回路径中的有关文件的信息。

atomic_move(src, dest, unsafe_writes=False, keep_dest_attrs=True): 将 src 原子移动到 dest，从 dest 复制属性，在成功时返回 true，它使用 os.rename 来确保这是原子操作，函数的其余部分是围绕限制、特殊情况进行的，并确保尽可能保存 selinux 上下文

backup_local(fn): 对指定文件进行日期标记备份，在成功或失败时返回 True 或 False

boolean(arg): 将参数转换为布尔值

digest_from_file(filename, algorithm): 返回指定名称的摘要方法的本地文件的十六进制摘要，如果文件不存在，则返回 None。

exit_json(**kwargs) → NoReturn: 从模块返回，没有错误

fail_json(msg, **kwargs) → NoReturn: 从模块返回，并显示错误消息

find_mount_point(path)

接收路径并返回其挂载点

参数:: path – 包含文件系统路径的字符串类型
返回值:: 挂载点的路径，作为文本类型

get_bin_path(arg, required=False, opt_dirs=None)

在 PATH 中查找系统可执行文件。

参数:

arg – 要查找的可执行文件。
required – 如果未找到可执行文件并且 required 为 True，则 fail_json
opt_dirs – 除 PATH 之外要搜索的可选目录列表

返回值:

如果找到，则返回完整路径；否则返回原始参数，除非 ‘warning’，则返回 None

引发:

Sysexit: 如果未找到 arg 并且 required=True（通过 fail_json）

is_executable(path)

给定的路径是否可执行？

参数:: path – 要检查的文件的路径。

限制

不考虑 FSACL。
大多数情况下，我们真正想知道的是“当前用户是否可以执行此文件”。此函数不会告诉我们，只会告诉我们是否设置了任何执行位。

is_special_selinux_path(path): 如果给定路径位于 NFS 或其他“特殊”文件系统挂载点，则返回一个包含 (True, selinux_context) 的元组，否则返回将为 (False, None)。

load_file_common_arguments(params, path=None)

许多模块处理文件，这封装了文件模块接受的通用选项，以便它可以直接提供给所有模块，并且它们可以共享代码。

允许通过提供路径来覆盖 path/dest 模块参数。

md5(filename)

使用 digest_from_file() 返回本地文件的 MD5 十六进制摘要。

除非别无选择，否则不要使用此函数

可选向后兼容性
与第三方协议的兼容性

此函数将无法在符合 FIPS-140-2 的系统上运行。

此函数的大多数用法可以使用 module.sha1 函数代替。

preserved_copy(src, dest): 复制文件并保留所有权、权限和上下文

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, umask=None, encoding='utf-8', errors='surrogate_or_strict', expand_user_and_vars=True, pass_fds=None, before_communicate_callback=None, ignore_invalid_cwd=True, handle_exceptions=True)

执行命令，返回 rc、stdout 和 stderr。

该方法读取 stdout 和 stderr 的机制与 CPython subprocess.Popen.communicate 不同，该方法将在生成命令退出且 stdout 和 stderr 被消耗后停止读取，而不是等到 stdout/stderr 关闭。当考虑到派生的或后台进程可能比生成命令保持 stdout 或 stderr 打开更长时间时，这可能是一个重要的区别。

参数:: args - 要运行的命令 * 如果 args 是一个列表，则命令将在 shell=False 的情况下运行。 * 如果 args 是一个字符串并且 use_unsafe_shell=False，它将把 args 拆分为一个列表并在 shell=False 的情况下运行 * 如果 args 是一个字符串并且 use_unsafe_shell=True，它将在 shell=True 的情况下运行。
Kw check_rc:: 非零 RC 时是否调用 fail_json。默认为 False
Kw close_fds:: 参见 subprocess.Popen() 的文档。默认为 True
Kw executable:: 参见 subprocess.Popen() 的文档。默认为 None
Kw data:: 如果给出，则信息将写入命令的 stdin
Kw binary_data:: 如果为 False，则在数据后附加一个换行符。默认为 False
Kw path_prefix:: 如果给出，则为在其中查找命令的额外路径。这将添加到 PATH 环境变量中，因此相同目录中的辅助命令也可以被找到
Kw cwd:: 如果给出，则为在其中运行命令的工作目录
Kw use_unsafe_shell:: 参见 args 参数。默认为 False
Kw prompt_regex:: 正则表达式字符串（不是已编译的正则表达式），可用于检测 stdout 中的提示，否则会导致执行挂起（尤其是在未指定输入数据的情况下）
Kw environ_update:: 用于 *更新* 环境变量的字典
Kw umask:: 运行命令时要使用的 umask。默认为 None
Kw encoding:: 由于我们返回本机字符串，因此在 python3 中，我们需要知道要使用的编码才能从字节转换为文本。如果你想始终获取字节，请使用 encoding=None。默认值为 “utf-8”。这不会影响作为 args 给出的字符串的转换。
Kw errors:: 由于我们返回本机字符串，因此在 python3 中，我们需要将 stdout 和 stderr 从字节转换为文本。如果字节在指定的 encoding 中不可解码，则使用此错误处理程序来处理它们。默认值为 surrogate_or_strict，这意味着如果可用（在我们支持的所有 python3 版本中都可用），字节将使用 surrogateescape 错误处理程序解码，否则将引发 UnicodeError 跟踪。这不会影响作为 args 给出的字符串的转换。
Kw expand_user_and_vars:: 当 use_unsafe_shell=False 时，此参数决定是否在运行命令之前在路径中扩展 ~ 并扩展环境变量。当 True 时，即使转义，例如 $SHELL 之类的字符串也将被扩展。当 False 且 use_unsafe_shell=False 时，不会进行任何路径或变量扩展。
Kw pass_fds:: 在 Python 3 上运行时，此参数决定应将哪些文件描述符传递给底层的 Popen 构造函数。在 Python 2 中，这将把 close_fds 设置为 False。
Kw before_communicate_callback:: 创建 Popen 对象后但在与进程通信之前将调用此函数。（Popen 对象将作为第一个参数传递给回调）
Kw ignore_invalid_cwd:: 此标志指示是否应忽略无效的 cwd（不存在或不是目录）或应引发异常。
Kw handle_exceptions:: 此标志指示是否应内联处理异常并发出 failed_json，或者调用者是否应处理它。
返回值:: 返回代码（整数）、stdout（本机字符串）和 stderr（本机字符串）的 3 元组。在 python2 中，stdout 和 stderr 都是字节字符串。在 python3 中，stdout 和 stderr 是根据 encoding 和 errors 参数转换的文本字符串。如果你想要 python3 上的字节字符串，请使用 encoding=None 来关闭解码为文本。

sha1(filename): 使用 digest_from_file() 返回本地文件的 SHA1 十六进制摘要。

sha256(filename): 使用 digest_from_file() 返回本地文件的 SHA-256 十六进制摘要。

基本

要使用此功能，请在你的模块中包含 import ansible.module_utils.basic。

ansible.module_utils.basic.get_all_subclasses(cls): 已弃用：改用 ansible.module_utils.common._utils.get_all_subclasses

ansible.module_utils.basic.get_platform()

已弃用 直接使用 platform.system()。

返回值:: 模块运行的平台的名称，在本机字符串中

返回一个本机字符串，该字符串标记平台（“Linux”、“Solaris”等）。目前，这是调用 platform.system() 的结果。

ansible.module_utils.basic.heuristic_log_sanitize(data, no_log_values=None): 从日志消息中删除看起来像密码的字符串

ansible.module_utils.basic.load_platform_subclass(cls, *args, **kwargs): 已弃用：改用 ansible.module_utils.common.sys_info.get_platform_subclass

参数规范

用于根据参数规范验证参数的类和函数。

参数规范验证器

class ansible.module_utils.common.arg_spec.ArgumentSpecValidator(argument_spec, mutually_exclusive=None, required_together=None, required_one_of=None, required_if=None, required_by=None)

参数规范验证类

根据 argument_spec 创建一个验证器，该验证器可用于使用 validate() 方法验证多个参数。

参数:

argument_spec (dict[str, dict]) – 有效参数及其类型的规范。可能包含嵌套的参数规范。
mutually_exclusive (list[str] or list[list[str]]) – 术语列表或术语列表列表，这些术语不应同时提供。
required_together (list[list[str]]) – 术语列表列表，这些术语需要同时提供。
required_one_of (list[list[str]]) – 术语列表列表，每个列表中需要一个术语。
required_if (list) – [parameter, value, [parameters]] 列表，如果 parameter == value，则需要其中一个 [parameters]。
required_by (dict[str, list[str]]) – 参数名称字典，其中包含字典中每个键所需的的参数列表。

validate(parameters, *args, **kwargs)

根据参数规范验证 parameters。

ValidationResult 中的错误消息可能包含 no_log 值，应使用 sanitize_keys() 在记录或显示之前进行清理。

参数:

parameters (dict[str, dict]) – 要根据参数规范验证的参数

返回值:

ValidationResult 包含已验证的参数。

简单示例:

argument_spec = {
    'name': {'type': 'str'},
    'age': {'type': 'int'},
}

parameters = {
    'name': 'bo',
    'age': '42',
}

validator = ArgumentSpecValidator(argument_spec)
result = validator.validate(parameters)

if result.error_messages:
    sys.exit("Validation failed: {0}".format(", ".join(result.error_messages))

valid_params = result.validated_parameters

ValidationResult

class ansible.module_utils.common.arg_spec.ValidationResult(parameters)

参数规范验证的结果。

这是 ArgumentSpecValidator.validate() 返回的对象，其中包含已验证的参数和任何错误。

参数:: parameters (dict) – 要验证并强制转换为正确类型的术语。

errors: AnsibleValidationErrorMultiple 包含所有 AnsibleValidationError 对象（如果有的话），如果在验证期间出现任何错误。

property validated_parameters: 已验证并强制转换的参数。

property unsupported_parameters: set 不支持的参数名称。

property error_messages: list 来自 errors 中每个异常的所有错误消息。

参数

ansible.module_utils.common.parameters.DEFAULT_TYPE_VALIDATORS: dict 类型名称（如 'str'）和用于检查该类型的默认函数，在本例中为 check_type_str()。

ansible.module_utils.common.parameters.env_fallback(*args, **kwargs): 从环境变量加载值

ansible.module_utils.common.parameters.remove_values(value, no_log_strings)

从 value 中删除 no_log_strings 中的字符串。

如果 value 是容器类型，则删除更多内容。

使用 deferred_removals 而不是纯递归解决方案，是因为在处理大量数据时可能会达到最大递归深度（请参阅 issue #24560）。

ansible.module_utils.common.parameters.sanitize_keys(obj, no_log_strings, ignore_keys=frozenset({}))

通过从键名中删除 no_log 值来清理容器对象中的键。

这是 remove_values() 函数的辅助函数。与该函数类似，我们使用 deferred_removals 来避免在大型数据结构的情况下达到最大递归深度。

参数:

obj – 要清理的容器对象。非容器对象将被返回而不修改。
no_log_strings – 我们不想记录的一组字符串值。
ignore_keys – 要不清理的键的一组字符串值。

返回值:

一个具有清理后的键的对象。

验证

用于验证各种参数类型的独立函数。

ansible.module_utils.common.validation.check_missing_parameters(parameters, required_parameters=None)

这是用于在无法通过 argspec 检查所需参数时检查所需参数，因为我们需要比 argspec 中提供的更多信息。

如果缺少任何必需的参数，则会引发 TypeError

参数:

parameters – 参数字典
required_parameters – 要在给定参数中查找的参数列表。

返回值:

空列表，或者如果检查失败则会引发 TypeError。

ansible.module_utils.common.validation.check_mutually_exclusive(terms, parameters, options_context=None)

根据参数参数检查互斥项

接受单个列表或列表列表，这些列表是彼此互斥的术语组

参数:

terms – 互斥参数列表
parameters – 参数字典
options_context – 如果terms位于子规范中，则为父键名称的字符串列表。

返回值:

空列表，或者如果检查失败则会引发 TypeError。

ansible.module_utils.common.validation.check_required_arguments(argument_spec, parameters, options_context=None)

检查 argument_spec 中的所有参数，并返回在 parameters 中未出现的必需参数列表。

如果检查失败，则引发 TypeError

参数:

argument_spec – 包含所有参数及其规范的 Argument spec 字典
parameters – 参数字典
options_context – 如果argument_spec位于子规范中，则为父键名称的字符串列表。

返回值:

空列表，或者如果检查失败则会引发 TypeError。

ansible.module_utils.common.validation.check_required_by(requirements, parameters, options_context=None)

对于 requirements 中的每个键，检查相应的列表以查看它们是否存在于 parameters 中。

为每个键接受单个字符串或值列表。

参数:

requirements – 需求字典
parameters – 参数字典
options_context – 如果requirements位于子规范中，则为父键名称的字符串列表。

返回值:

空字典或如果检查失败，则引发 TypeError。

ansible.module_utils.common.validation.check_required_if(requirements, parameters, options_context=None)

检查有条件要求的参数。

如果检查失败，则引发 TypeError

参数:: requirements – 指定参数、值、当给定参数为指定值时所需的参数以及可选的布尔值（指示任何或所有参数都是必需的）的列表列表。
示例：

required_if=[
    ['state', 'present', ('path',), True],
    ['someint', 99, ('bool_param', 'string_param')],
]

参数:

parameters – 参数字典
options_context – 如果requirements位于子规范中，则为父键名称的字符串列表。

返回值:

空列表或如果检查失败，则引发 TypeError。异常的 results 属性包含字典列表。每个字典都是评估 requirements 中每个项目的结果。每个返回的字典包含以下键

key missing：

缺少的必需参数列表

key requires：

’any’ 或 ‘all’

key parameter：

具有需求的参数名称

key value：

参数的原始值

key requirements：

原始必需参数

示例：

[
    {
        'parameter': 'someint',
        'value': 99
        'requirements': ('bool_param', 'string_param'),
        'missing': ['string_param'],
        'requires': 'all',
    }
]

ansible.module_utils.common.validation.check_required_one_of(terms, parameters, options_context=None)

检查每个术语列表，以确保至少一个存在于给定的模块参数中

接受列表列表或元组。

参数:

terms – 要检查的术语列表列表。对于每个术语列表，至少需要一个。
parameters – 参数字典
options_context – 如果terms位于子规范中，则为父键名称的字符串列表。

返回值:

空列表，或者如果检查失败则会引发 TypeError。

ansible.module_utils.common.validation.check_required_together(terms, parameters, options_context=None)

检查每个术语列表，以确保每个列表中的每个参数都存在于给定的参数中。

接受列表列表或元组。

参数:

terms – 要检查的术语列表列表。每个列表应包含当至少一个在参数中指定时都必需的参数。
parameters – 参数字典
options_context – 如果terms位于子规范中，则为父键名称的字符串列表。

返回值:

空列表，或者如果检查失败则会引发 TypeError。

ansible.module_utils.common.validation.check_type_bits(value)

将人类可读的字符串位值转换为整数中的位。

示例：check_type_bits('1Mb')返回整数 1048576。

如果无法转换值，则引发 TypeError。

ansible.module_utils.common.validation.check_type_bool(value)

验证值是否为 bool 或将其转换为 bool 并返回。

如果无法转换为 bool，则引发 TypeError

参数:: value – 要转换为 bool 的字符串、int 或 float。有效的布尔值包括：’1’，’on’，1，’0’，0，’n’，’f’，’false’，’true’，’y’，’t’，’yes’，’no’，’off’
返回值:: 布尔 True 或 False

ansible.module_utils.common.validation.check_type_bytes(value)

将人类可读的字符串值转换为字节

如果无法转换值，则引发 TypeError

ansible.module_utils.common.validation.check_type_dict(value)

验证值是否为 dict 或将其转换为 dict 并返回。

如果无法转换为 dict，则引发 TypeError

参数:: value – 要转换为 dict 的 Dict 或字符串。接受k1=v2, k2=v2或k1=v2 k2=v2。
返回值:: 转换为字典的值

ansible.module_utils.common.validation.check_type_float(value)

验证值是否为 float 或将其转换为 float 并返回

如果无法转换为 float，则引发 TypeError

参数:: value – 要验证或转换并返回的 float、int、str 或 bytes。
返回值:: 给定值的 float。

ansible.module_utils.common.validation.check_type_int(value)

验证值是否为整数并返回它，或将值转换为整数并返回它

如果无法转换为 int，则引发 TypeError

参数:: value – 要转换或验证的字符串或 int
返回值:: 给定值的 int

ansible.module_utils.common.validation.check_type_jsonarg(value)

返回 json 化字符串。有时控制器将 json 字符串转换为 dict/list，因此在此将其转换回 json

如果无法转换值，则引发 TypeError

ansible.module_utils.common.validation.check_type_list(value)

验证值是否为列表或转换为列表

用逗号分隔的字符串将被拆分为列表。如果无法转换为列表，则引发 TypeError。

参数:: value – 要验证或转换为列表的值
返回值:: 如果它已经是列表，则为原始值；如果为 float、int 或不带逗号的字符串，则为单项列表；如果为用逗号分隔的字符串，则为多项列表。

ansible.module_utils.common.validation.check_type_path(value): 验证提供的值是否为字符串或将其转换为字符串，然后返回扩展路径

ansible.module_utils.common.validation.check_type_raw(value): 返回原始值

ansible.module_utils.common.validation.check_type_str(value, allow_conversion=True, param=None, prefix='')

验证值是否为字符串或将其转换为字符串。

由于在转换为字符串时有时会发生意外更改，allow_conversion 控制是否将值转换或如果值不是字符串并且将被转换，则引发 TypeError。

参数:

value – 要验证或转换为字符串的值
allow_conversion – 是否转换字符串并返回它，或者引发 TypeError

返回值:

如果为字符串，则为原始值，如果 allow_conversion=True，则为转换为字符串的值，或者如果 allow_conversion=False，则引发 TypeError。

ansible.module_utils.common.validation.count_terms(terms, parameters)

计算给定字典中键的出现次数

参数:

terms – 要检查的值的字符串或可迭代对象
parameters – 参数字典

返回值:

提供的字典中 terms 值的出现次数的整数。

错误

exception ansible.module_utils.errors.AnsibleFallbackNotFound: 未找到回退验证器

exception ansible.module_utils.errors.AnsibleValidationError(message)

单个参数规范验证错误

error_message: 引发异常时传入的错误消息。

property msg: 引发异常时传入的错误消息。

exception ansible.module_utils.errors.AnsibleValidationErrorMultiple(errors=None)

多个参数规范验证错误

errors: list of AnsibleValidationError objects

property msg: errors 中第一个错误中的第一条消息。

property messages: list of errors 中每个错误消息。

append(error)

将新错误追加到 self.errors。

仅应添加 AnsibleValidationError。

extend(errors): 将 errors 中的每个项目追加到 self.errors。仅应添加 AnsibleValidationError。

exception ansible.module_utils.errors.AliasError(message): 错误处理别名

exception ansible.module_utils.errors.ArgumentTypeError(message): 参数类型错误

exception ansible.module_utils.errors.ArgumentValueError(message): 参数值错误

exception ansible.module_utils.errors.DeprecationError(message): 错误处理参数弃用

exception ansible.module_utils.errors.ElementError(message): 验证元素时出错

exception ansible.module_utils.errors.MutuallyExclusiveError(message): 提供了互斥的参数

exception ansible.module_utils.errors.NoLogError(message): 错误转换 no_log 值

exception ansible.module_utils.errors.RequiredByError(message): 与其他参数所需的参数有关的错误

exception ansible.module_utils.errors.RequiredDefaultError(message): 必需的参数被分配了默认值

exception ansible.module_utils.errors.RequiredError(message): 缺少必需的参数

exception ansible.module_utils.errors.RequiredIfError(message): 与条件所需参数有关的错误

exception ansible.module_utils.errors.RequiredOneOfError(message): 与至少需要一个参数的参数有关的错误

exception ansible.module_utils.errors.RequiredTogetherError(message): 与需要一起的参数有关的错误

exception ansible.module_utils.errors.SubParameterTypeError(message): 子参数类型不正确

exception ansible.module_utils.errors.UnsupportedError(message): 提供了不支持的参数