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

Примечание

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

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

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

Для использования в playbook укажите: community.vmware.vmware_host_custom_attributes.

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

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

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

Параметры

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

Примечания

Примечание

Все модули требуют доступ API на запись и, следовательно, не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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 словарь	метаданные об атрибутах ESXi хоста Возвращено: изменён Пример: `{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_custom_attributes_module.html