community.vmware.vmware_vm_inventory清单 – VMware虚拟机清单源

注意

此清单插件是 community.vmware集合 (版本5.2.0) 的一部分。

如果您使用的是ansible包，则可能已安装此集合。它不包含在ansible-core中。要检查是否已安装，请运行ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。您需要其他要求才能使用此清单插件，请参阅需求了解更多详情。

要在playbook中使用它，请指定：community.vmware.vmware_vm_inventory。

概要 

从VMware环境获取虚拟机作为清单主机。
使用任何以vmware.yml、vmware.yaml、vmware_vm_inventory.yml或vmware_vm_inventory.yaml结尾的文件作为YAML配置文件。

需求 

以下需求是在执行此清单的本地控制器节点上需要的。

requests >= 2.3
vSphere Automation SDK - 用于标签功能

参数 

参数	注释
cache 布尔值	切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能工作。选项 `false` ← (默认) `true` 配置 INI条目 [inventory] cache = false 环境变量：`ANSIBLE_INVENTORY_CACHE`
cache_connection 字符串	缓存连接数据或路径，请阅读缓存插件文档以了解详细信息。配置 INI条目 [defaults] fact_caching_connection = VALUE [inventory] cache_connection = VALUE 环境变量：`ANSIBLE_CACHE_PLUGIN_CONNECTION` 环境变量：`ANSIBLE_INVENTORY_CACHE_CONNECTION`
cache_plugin 字符串	要用于清单源数据的缓存插件。默认值： `"memory"` 配置 INI条目 [defaults] fact_caching = memory [inventory] cache_plugin = memory 环境变量：`ANSIBLE_CACHE_PLUGIN` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN`
cache_prefix 字符串	用于缓存插件文件/表的前缀默认值： `"ansible_inventory_"` 配置 INI条目 [defaults] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ 环境变量：`ANSIBLE_CACHE_PLUGIN_PREFIX` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX`
cache_timeout 整数	缓存持续时间（秒）默认值： `3600` 配置 INI条目 [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 环境变量：`ANSIBLE_CACHE_PLUGIN_TIMEOUT` 环境变量：`ANSIBLE_INVENTORY_CACHE_TIMEOUT`
compose 字典	从jinja2表达式创建变量。默认值： `{}`
filters 列表 / 元素=字符串	此选项允许使用jinja模板对客户端进行主机过滤。在引入服务器端过滤后，应优先使用服务器端过滤。默认值： `[]`
groups 字典	根据Jinja2条件将主机添加到组。默认值： `{}`
hostname 字符串 / 必需	vCenter或ESXi服务器的名称。配置环境变量：`VMWARE_HOST` 环境变量：`VMWARE_SERVER`
hostnames 列表 / 元素=字符串	按优先级顺序排列的模板列表，用于组合inventory_hostname。如果结果为空字符串或None值，则忽略模板。您可以在`properties`中指定的属性作为模板中的变量。默认值： `["config.name + \"_\" + config.uuid"]`
keyed_groups 列表 / 元素=字典	根据变量的值将主机添加到组。默认值： `[{"key": "config.guestId", "separator": ""}, {"key": "summary.runtime.powerState", "separator": ""}]`
默认值字符串 ansible-core 2.12版本中添加	当主机变量的值为空字符串时的默认值。此选项与`keyed_groups[].trailing_separator`互斥。
键字符串	用于生成组的输入字典中的键
父组字符串	键控组的父组
前缀字符串	键控组名称将以此前缀开头默认值： `""`
分隔符字符串	用于构建键控组名称的分隔符默认值： `"_"`
尾部分隔符布尔值 ansible-core 2.12版本中添加	将此选项设置为`False` 以省略主机变量值为空字符串时`keyed_groups[].separator`后面的`keyed_groups[].separator`。此选项与`keyed_groups[].default_value`互斥。选项 `false` `true` ← (默认)
前导分隔符布尔值 ansible-core 2.11版本中添加	与keyed_groups一起使用。默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。这是因为默认前缀是“”而默认分隔符是“_”。如果未给出前缀，请将此选项设置为False以省略前导下划线（或其他分隔符）。如果组名称是从映射中派生的，则仍然使用分隔符来连接项目。要完全不使用组名称中的分隔符，请将键控组的分隔符设置为空字符串。选项 `false` `true` ← (默认)
密码字符串 / 必需	vSphere用户的密码。接受使用Vault加密的变量。接受Jinja模板化的值配置环境变量：`VMWARE_PASSWORD`
端口整数	用于连接到vCenter或ESXi服务器的端口号。默认值： `443` 配置环境变量：`VMWARE_PORT`
属性列表 / 元素=字符串	指定与虚拟机关联的VMware模式属性列表。这些属性将填充到给定虚拟机的hostvars中。列表中的每个值都可以是VM对象中特定属性的路径，也可以是VM对象集合的路径。如果`hostnames`设置为默认值，则`config.name`和`config.uuid`是必需属性。如果`keyed_groups`设置为默认值，则`config.guestId`和`summary.runtime.powerState`是必需的。请确保此选项中包含在其他参数中使用的所有属性。除了VM属性外，以下是一些特殊值使用`customValue`填充虚拟机的自定义属性。`customValue`仅受vCenter支持，不受ESXi支持。使用`all`填充虚拟机的所有属性。`all`值是一个耗时的操作，除非绝对需要，否则不要使用。请参考更多可作为属性使用的VMware客户机属性https://docs.ansible.org.cn/ansible/latest/collections/community/vmware/docsite/vmware_scenarios/vmware_inventory_vm_attributes.html 默认值： `["name", "config.cpuHotAddEnabled", "config.cpuHotRemoveEnabled", "config.instanceUuid", "config.hardware.numCPU", "config.template", "config.name", "config.uuid", "guest.hostName", "guest.ipAddress", "guest.guestId", "guest.guestState", "runtime.maxMemoryUsage", "customValue", "summary.runtime.powerState", "config.guestId"]`
代理主机字符串	将接收所有HTTPS请求并转发它们的代理的地址。格式为主机名或IP地址。配置环境变量：`VMWARE_PROXY_HOST`
代理端口整数	将接收所有HTTPS请求并转发它们的HTTP代理的端口。配置环境变量：`VMWARE_PROXY_PORT`
资源列表 / 元素=字典	用于限制搜索范围的资源列表。每个资源项都由一个`'vim_type_snake_case`:`list of resource names`对和可选的嵌套_resources_组成键名基于vim类型名称的蛇形大小写；例如`host_system`对应于`vim.HostSystem` 参见VIM类型默认值： `[]`
严格模式布尔值	如果设置为`yes`，则将无效条目视为致命错误，否则跳过并继续。由于可以在表达式中使用facts，因此它们可能并不总是可用，因此我们默认忽略这些错误。选项 `false` ← (默认) `true`
子属性列表 / 元素=字典 community.vmware 4.2.0版本中添加	普通属性的子属性列表。这些子属性也将填充到给定虚拟机的hostvars中。默认值： `[]`
属性字符串 / 必需	属性名称
子元素列表 / 元素=字符串	子元素列表
使用额外变量布尔值 ansible-core 2.11版本中添加	将额外变量合并到可用于组合的变量中（最高优先级）。选项 `false` ← (默认) `true` 配置 INI条目 [inventory_plugins] use_extra_vars = false 环境变量：`ANSIBLE_INVENTORY_USE_EXTRA_VARS`
用户名字符串 / 必需	vSphere用户名。接受使用Vault加密的变量。接受Jinja模板化的值配置环境变量：`VMWARE_USER` 环境变量：`VMWARE_USERNAME`
验证证书布尔值	当SSL证书无效时允许连接。当证书不受信任时，设置为`false`。选项 `false` `true` ← (默认) 配置环境变量：`VMWARE_VALIDATE_CERTS`
使用嵌套属性布尔值	此选项将扁平化的属性名称转换为嵌套字典。选项 `false` `true` ← (默认)
使用路径布尔值	包含虚拟机的路径。将此选项设置为字符串值以替换来自“数据中心”的根名称。选项 `false` ← (默认) `true`
使用清理后的属性名称布尔值	此选项允许对属性名称进行清理，以创建安全的属性名称供Ansible使用。此外，将属性名称转换为蛇形大小写。选项 `false` ← (默认) `true`
使用标签布尔值	包含标签和关联的虚拟机。需要在给定的控制器机器上安装“vSphere Automation SDK”库。请参考以下URL了解安装步骤 https://code.vmware.com/web/sdk/7.0/vsphere-automation-python 选项 `false` ← (默认) `true`

示例 

# Sample configuration file for VMware Guest dynamic inventory
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    with_tags: true

# Sample configuration file for VMware Guest dynamic inventory using Jinja to template the username and password.
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: '{{ (lookup("file","~/.config/vmware.yaml") | from_yaml).username }}'
    password: '{{ (lookup("file","~/.config/vmware.yaml") | from_yaml).password }}'
    validate_certs: false
    with_tags: true

# Gather minimum set of properties for VMware guest
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'name'
    - 'guest.ipAddress'
    - 'config.name'
    - 'config.uuid'

# Gather subproperties such as the parent (mostly cluster) of an ESXi
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'name'
    - 'guest.ipAddress'
    - 'config.name'
    - 'config.uuid'
    subproperties:
    - property: 'summary.runtime.host'
      subelements:
      - 'name'
      - 'parent.name'

# Create Groups based upon VMware Tools status
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'name'
    - 'config.name'
    - 'guest.toolsStatus'
    - 'guest.toolsRunningStatus'
    hostnames:
    - config.name
    keyed_groups:
    - key: guest.toolsStatus
      separator: ''
    - key: guest.toolsRunningStatus
      separator: ''

# Filter VMs based upon condition
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'runtime.powerState'
    - 'config.name'
    filters:
    - runtime.powerState == "poweredOn"
    hostnames:
    - config.name

# Filter VM's based on OR conditions
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'name'
    - 'config.name'
    - 'guest.ipAddress'
    - 'guest.toolsStatus'
    - 'guest.toolsRunningStatus'
    - 'config.guestFullName'
    - 'config.guestId'
    hostnames:
    - 'config.name'
    filters:
    - config.guestId == "rhel7_64Guest" or config.name == "rhel_20_04_empty"

# Filter VM's based on regex conditions
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'config.name'
    - 'config.guestId'
    - 'guest.ipAddress'
    - 'summary.runtime.powerState'
    filters:
    - guest.ipAddress is defined and (guest.ipAddress is match('192.168.*') or guest.ipAddress is match('192.169.*'))

# Using compose and groups
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    properties:
    - 'name'
    - 'config.name'
    - 'guest.ipAddress'
    compose:
      # This will populate the IP address of virtual machine if available
      # and will be used while communicating to the given virtual machine
      ansible_host: 'guest.ipAddress'
      composed_var: 'config.name'
      # This will populate a host variable with a string value
      ansible_user: "'admin'"
      ansible_connection: "'ssh'"
    groups:
      VMs: true
    hostnames:
    - config.name

# Use Datacenter, Cluster and Folder value to list VMs
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.200.241
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    with_tags: true
    resources:
      - datacenter:
        - Asia-Datacenter1
        - Asia-Datacenter2
        resources:
        - compute_resource:
          - Asia-Cluster1
          resources:
          - host_system:
            - Asia-ESXI4
        - folder:
          - dev
          - prod

# Use Category and it's relation with Tag
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.201.128
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    hostnames:
    - 'config.name'
    properties:
    - 'config.name'
    - 'config.guestId'
    - 'guest.ipAddress'
    - 'summary.runtime.powerState'
    with_tags: true
    keyed_groups:
    - key: tag_category.OS
      prefix: "vmware_tag_os_category_"
      separator: ""
    with_nested_properties: true
    filters:
    - "tag_category.OS is defined and 'Linux' in tag_category.OS"

# customizing hostnames based on VM's FQDN. The second hostnames template acts as a fallback mechanism.
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    hostnames:
     - 'config.name+"."+guest.ipStack.0.dnsConfig.domainName'
     - 'config.name'
    properties:
      - 'config.name'
      - 'config.guestId'
      - 'guest.hostName'
      - 'guest.ipAddress'
      - 'guest.guestFamily'
      - 'guest.ipStack'

# Select a specific IP address for use by ansible when multiple NICs are present on the VM
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.223.31
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    compose:
      # Set the IP address used by ansible to one that starts by 10.42. or 10.43.
      ansible_host: >-
        guest.net
        | selectattr('ipAddress')
        | map(attribute='ipAddress')
        | flatten
        | select('match', '^10.42.*|^10.43.*')
        | list
        | first
    properties:
      - guest.net

# Group hosts using Jinja2 conditionals
    plugin: community.vmware.vmware_vm_inventory
    strict: false
    hostname: 10.65.13.37
    username: [email protected]
    password: Esxi@123$%
    validate_certs: false
    hostnames:
    - config.name
    properties:
    - 'name'
    - 'config.name'
    - 'config.datastoreUrl'
    groups:
      slow_storage: "'Nas01' in config.datastoreUrl[0].name"
      fast_storage: "'SSD' in config.datastoreUrl[0].name"

作者

Abhijeet Kasurde (@Akasurde)

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。