Модуль community.vmware.vmware_object_custom_attributes_info — сбор пользовательских атрибутов объекта

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать коллекцию в плейбуке, укажите: community.vmware.vmware_object_custom_attributes_info.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль собирает пользовательские атрибуты объекта.

Параметры

Параметр	Комментарии
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
moid string	Идентификатор управляемого объекта экземпляра, если он известен. Этот уникальный идентификатор действителен только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не указан `object_name`.
object_name псевдонимы: name string	Имя объекта, с которым нужно работать.
object_type string / обязательный	Тип объекта, с которым нужно работать. Варианты: `"Datacenter"` `"Cluster"` `"HostSystem"` `"ResourcePool"` `"Folder"` `"VirtualMachine"` `"DistributedVirtualSwitch"` `"DistributedVirtualPortgroup"` `"Datastore"`
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Если сертификаты не являются доверенными, установите значение `false`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддерживает check_mode.
Для работы всех модулей необходим доступ на запись через API, поэтому они не поддерживаются бесплатной лицензией ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Чтобы указать хранилище сертификатов, задайте переменную окружения REQUESTS_CA_BUNDLE. Обратите внимание: в некоторых случаях при заданной переменной значение ‘false’ для параметра ‘validate_certs’ может игнорироваться. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Gather custom attributes of a virtual machine
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    object_name: "{{ object_name }}"
  register: vm_attributes

- name: Gather custom attributes of a virtual machine with moid
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    moid: "{{ moid }}"
  register: vm_attributes

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
custom_attributes list / элементы=string	Список пользовательских атрибутов объекта. Возвращается: всегда Пример: ["[\n {\n \"attribute\": \"example01\"", "\n \"key\": 132", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"10\"\n }", "\n {\n \"attribute\": \"example02\"", "\n \"key\": 131", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"20\"\n }", "\n {\n \"attribute\": \"example03\"", "\n \"key\": 130", "\n \"type\": \"VirtualMachine\"", "\n \"value\": null\n }\n]"]

Ключ

Описание

custom_attributes

list / элементы=string

Список пользовательских атрибутов объекта.

Возвращается: всегда

Пример: ["[\n {\n \"attribute\": \"example01\"", "\n \"key\": 132", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"10\"\n }", "\n {\n \"attribute\": \"example02\"", "\n \"key\": 131", "\n \"type\": \"VirtualMachine\"", "\n \"value\": \"20\"\n }", "\n {\n \"attribute\": \"example03\"", "\n \"key\": 130", "\n \"type\": \"VirtualMachine\"", "\n \"value\": null\n }\n]"]

Авторы

sky-joker (@sky-joker)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_object_custom_attributes_info_module.html