Модуль community.vmware.vmware_host_custom_attributes — управление пользовательскими атрибутами VMware для указанного узла ESXi

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

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

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

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

Этот модуль позволяет добавлять, удалять и обновлять пользовательские атрибуты для указанного узла ESXi.

Параметры

Параметр	Комментарии
attributes list / elements=dictionary	Список имён и значений пользовательских атрибутов, которыми необходимо управлять. Значение пользовательского атрибута необязательно и будет проигнорировано, если `state=absent`. По умолчанию: `[]`
name string / обязательно	Имя атрибута.
value string	Значение атрибута. По умолчанию: `""`
esxi_hostname string / обязательно	Имя узла ESXi, с которым нужно работать. Это обязательный параметр
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него используется значение переменной среды `VMWARE_HOST`.
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`.
state string	Выполняемое действие. Если задано значение `present`, пользовательский атрибут добавляется или обновляется. Если задано значение `absent`, пользовательский атрибут удаляется. Варианты: `"present"` ← (по умолчанию) `"absent"`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него используется значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение при недействительных SSL-сертификатах. Если сертификаты не являются доверенными, задайте значение `false`. Если значение не указано в задаче, вместо него используется значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Add ESXi host custom attributes
  community.vmware.vmware_host_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: host1
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost
  register: attributes

- name: Remove ESXi host Attribute
  community.vmware.vmware_host_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: host1
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

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

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

Ключ	Описание
custom_attributes dictionary	метаданные об атрибутах узла ESXi Возвращается: changed Пример: `{"mycustom": "my_custom_value", "mycustom_2": "my_custom_value_2", "sample_1": "sample_1_value", "sample_2": "sample_2_value", "sample_3": "sample_3_value"}`

Авторы

Hunter Christain (@exp-hc)

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

© 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_host_custom_attributes_module.html