ansible_sdk.model.job_def 模块

class ansible_sdk.model.job_def.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 – Runner 执行 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