模块默认值

如果您经常使用相同的参数调用相同的模块，则可以使用module_defaults关键字为该特定模块定义默认参数。

这是一个基本的例子

- hosts: localhost
  module_defaults:
    ansible.builtin.file:
      owner: root
      group: root
      mode: 0755
  tasks:
    - name: Create file1
      ansible.builtin.file:
        state: touch
        path: /tmp/file1

    - name: Create file2
      ansible.builtin.file:
        state: touch
        path: /tmp/file2

    - name: Create file3
      ansible.builtin.file:
        state: touch
        path: /tmp/file3

module_defaults关键字可以在剧本、块和任务级别使用。在任务中明确指定的任何模块参数都将覆盖为该模块参数建立的任何默认值。

- block:
    - name: Print a message
      ansible.builtin.debug:
        msg: "Different message"
  module_defaults:
    ansible.builtin.debug:
      msg: "Default message"

您可以通过指定一个空字典来移除之前为模块建立的任何默认值。

- name: Create file1
  ansible.builtin.file:
    state: touch
    path: /tmp/file1
  module_defaults:
    file: {}

注意

在剧本级别（以及在使用include_role或import_role时的块/任务级别）设置的任何模块默认值都将应用于使用的任何角色，这可能会导致角色出现意外行为。

以下是一些此功能更实际的用例。

与需要身份验证的API交互。

- hosts: localhost
  module_defaults:
    ansible.builtin.uri:
      force_basic_auth: true
      user: some_user
      password: some_password
  tasks:
    - name: Interact with a web service
      ansible.builtin.uri:
        url: http://some.api.host/v1/whatever1

    - name: Interact with a web service
      ansible.builtin.uri:
        url: http://some.api.host/v1/whatever2

    - name: Interact with a web service
      ansible.builtin.uri:
        url: http://some.api.host/v1/whatever3

为特定与EC2相关的模块设置默认AWS区域。

- hosts: localhost
  vars:
    my_region: us-west-2
  module_defaults:
    amazon.aws.ec2:
      region: '{{ my_region }}'
    community.aws.ec2_instance_info:
      region: '{{ my_region }}'
    amazon.aws.ec2_vpc_net_info:
      region: '{{ my_region }}'

模块默认值组

模块默认值组允许为属于同一组的模块提供公共参数。集合可以在其meta/runtime.yml文件中定义此类组。

注意

module_defaults不考虑collections关键字，因此必须在module_defaults中使用完全限定的组名来表示新的组。

这是一个ns.coll集合的runtime.yml文件示例。此文件定义了一个名为ns.coll.my_group的动作组，并将ns.coll中的sample_module和another.collection中的another_module放入该组。

# collections/ansible_collections/ns/coll/meta/runtime.yml
action_groups:
  my_group:
    - sample_module
    - another.collection.another_module

现在可以在剧本中这样使用此组

- hosts: localhost
  module_defaults:
    group/ns.coll.my_group:
      option_name: option_value
  tasks:
    - ns.coll.sample_module:
    - another.collection.another_module:

出于历史原因和向后兼容性，有一些特殊组

组	扩展模块组
aws	amazon.aws.aws 和 community.aws.aws
azure	azure.azcollection.azure
gcp	google.cloud.gcp
k8s	community.kubernetes.k8s, community.general.k8s, community.kubevirt.k8s, community.okd.k8s 和 kubernetes.core.k8s
os	openstack.cloud.os
acme	community.crypto.acme
docker*	community.general.docker 和 community.docker.docker
ovirt	ovirt.ovirt.ovirt 和 community.general.ovirt
vmware	community.vmware.vmware

• 查看集合或其meta/runtime.yml的文档，以查看该组中包含哪些动作插件和模块。

通过在组名前添加group/前缀（例如group/aws）来使用module_defaults中的组。

在剧本中，您可以为整个模块组设置模块默认值，例如设置公共AWS区域。

# example_play.yml
- hosts: localhost
  module_defaults:
    group/aws:
      region: us-west-2
  tasks:
  - name: Get info
    aws_s3_bucket_info:

  # now the region is shared between both info modules

  - name: Get info
    ec2_ami_info:
      filters:
        name: 'RHEL*7.5*'

有关meta/runtime.yml的更多信息，包括action_groups的完整格式，请参阅runtime.yml。