ansible_sdk 包

class ansible_sdk.AnsibleJobDef(*args, **kwargs)

基础：_DataclassReplaceMixin

常见的 Ansible 作业定义值

参数：:

  • data_dir – 包含 Ansible 项目内容和清单的目录结构的路径。

  • playbook – 在data_dir下运行的剧本的相对路径或 FQCN

  • inventory – 清单文件或目录在data_dir下的相对路径，类似于 Ansible 的-i选项

  • extra_vars – 具有最高优先级级别的变量字典，类似于 Ansible 的-e选项

  • env_vars – 运行 Ansible 时要使用的环境变量。

  • verbosity – 默认冗余度为 None 或 1-5，相当于 Ansible 的-v选项

  • limit – 与 Ansible 的--limit参数匹配，以进一步限制要使用的清单

  • ident – 此次 Runner 调用的运行标识符。将用于创建和命名保存调用结果的工件目录。

  • forks – 控制 Ansible 并发

  • module – 运行 Ansible 时，运行器将在 ad-hoc 模式下调用的模块。

  • module_args – 将提供给 ad-hoc 模式的模块参数。

  • host_pattern – 在 ad-hoc 模式下运行时要匹配的主机模式。

  • timeout – 执行命令时传递给subprocess调用的超时值（以秒为单位）。如果触发超时，它将强制取消执行。

  • role – 要执行的角色的名称。

  • roles_path – 要分配给 ANSIBLE_ROLES_PATH 的目录或目录列表

  • metrics_output_path – 收集指标的目录的路径

data_dir: str
env_vars: dict[str, t.Any]
extra_vars: dict[str, t.Any]
forks: int | None = None
host_pattern: str | None = None
ident: str | None = None
inventory: str | list[str] | None = None
limit: str | None = None
metrics_output_path: str | None = None
module: str | None = None
module_args: str | None = None
playbook: str
role: str | None = None
roles_path: str | list[str] | None = None
timeout: int | None = None
verbosity: int | None = None
class ansible_sdk.AnsibleJobEvent(name: str, raw_event_data: dict[str, Any])

Bases: Mapping

Ansible 事件的容器对象。

参数：:

  • name – 事件类型的名称

  • raw_event_data – 原始事件数据的字典

  • stdout – 与此事件关联的显示文本输出（如果有）

name: str
raw_event_data: dict[str, Any]
class ansible_sdk.AnsibleJobStatus(job_def: AnsibleJobDef)

Bases: object

用于监控正在运行/已完成作业的状态对象。

cancel()

请求执行器取消正在运行的作业。取消成功后，在运行迭代器和此作业对象的任何等待者上将引发 CancelledError。

drop_event(evt: AnsibleJobEvent)

请求丢弃不再需要的事件数据。

参数：:

evt – 要丢弃的返回的事件对象

property events: AsyncIterator[AnsibleJobEvent]

异步迭代器，用于枚举此作业的事件。事件在作业运行时实时产生；迭代器在作业完成或失败之前不会完成。在作业失败或取消的情况下，迭代器将引发包含适当详细信息的异常。

返回:

此作业的 AnsibleJobEvent 数据的实时迭代器

property stdout_lines: AsyncIterator[str]

异步迭代器，用于枚举此作业的显示输出文本行。文本行在作业运行时实时产生；迭代器在作业完成或失败之前不会完成。在作业失败或取消的情况下，迭代器将引发包含适当详细信息的异常。

返回:

Ansible 作业的显示输出文本行的迭代器

子包