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): 将参数转换为布尔值

deprecate(msg: str, version: str | None = None, date: str | None = None, collection_name: str | None = None, *, deprecator: PluginInfo | None = None, help_text: str | None = None) → None: 记录一条弃用警告，并随模块结果返回。大多数调用者不需要提供 `collection_name` 或 `deprecator`——如果需要，仅提供其中一个。指定 `version` 或 `date`，但不要同时指定。如果 `date` 是字符串，则必须采用 `YYYY-MM-DD` 格式。

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

error_as_warning(msg: str | None, exception: BaseException, *, help_text: str | None = None) → None: 将异常显示为警告。

exit_json(**kwargs) → NoReturn: 从模块成功返回，无错误

fail_json(msg: str, *, exception: BaseException | str | None = <object object>, **kwargs) → NoReturn

从模块返回错误消息和可选的异常/回溯详细信息。仅当启用了错误回溯捕获时，结果中才会包含回溯。

当 `exception` 是一个异常对象时，它的消息链将自动与 `msg` 组合以创建最终的错误消息。消息链包括异常本身的消息以及任何 `__cause__` 异常的消息。来自 `exception` 的回溯将用于格式化的回溯。

当 `exception` 是字符串时，它将被用作格式化的回溯。

当 `exception` 设置为 `None` 时，当前的调用栈将用于格式化的回溯。

当未指定 `exception` 时，将从当前异常中检索格式化的回溯。如果没有待处理的异常，则改用当前的调用栈。

find_mount_point(path)

获取一个路径并返回其挂载点

参数:: path – 具有文件系统路径的字符串类型
返回值:: 以文本类型表示的挂载点路径

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

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

参数:

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

返回值:

如果找到则返回完整路径；否则返回原始 arg，除非设置了‘warning’，则返回 None

引发:

系统退出：如果找不到 arg 且 required=True（通过 fail_json）

is_executable(path)

给定的路径是可执行的吗？

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

限制

不考虑文件系统 ACL (FSACL)。
大多数时候我们真正想知道的是“当前用户是否可以执行此文件”。此函数不提供该信息，仅说明是否设置了任何执行位。

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

load_file_common_arguments(params, path=None)

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

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

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

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

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

基础 (Basic)

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

ansible.module_utils.basic.get_platform()

返回值:: 模块运行所在的平台名称（原生字符串）

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

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

参数规范 (Argument Spec)

用于针对参数规范验证参数的类和函数。

ArgumentSpecValidator

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: 如果验证期间有任何失败，则包含所有 AnsibleValidationError 对象的 AnsibleValidationErrorMultiple。

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

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

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

参数 (Parameters)

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

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

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

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

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

存在 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 – 不进行清理的一组键的字符串值。

返回值:

具有已清理键的对象。

验证 (Validation)

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

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 – 包含所有参数及其规范的参数规范字典
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 中每个项的结果。每个返回的字典包含以下键

键 missing:

必需但缺失的参数列表

键 requires:

‘any’ 或 ‘all’

键 parameter:

具有该要求的参数名称

键 value:

参数的原始值

键 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)

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

示例：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 的字典或字符串。接受 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 序列化字典/列表/元组，去掉 str 和 bytes。以前在 Ansible/Jinja 经典模式字面量评估过程中可能无意中反序列化对象的情况下需要。

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 – 参数字典

返回值:

一个整数，表示提供的字典中术语值出现的次数。

错误 (Errors)

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: AnsibleValidationError 对象的 list

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

property messages: errors 中每条错误消息的 list。

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): 提供了不支持的参数