Модуль community.vmware.vmware_guest_custom_attribute_defs – Управление определениями пользовательских атрибутов для виртуальной машины из VMware

Примечание

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

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

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

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

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

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

Этот модуль может использоваться для добавления и удаления определений пользовательских атрибутов для данной виртуальной машины из VMware.

Параметры

Параметр	Комментарии
attribute_key string	Имя определения пользовательского атрибута. Это обязательный параметр, если `state=present` или `state=absent`.
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` и определение отсутствует, то создается определение пользовательского атрибута. Если установлено в `present` и определение присутствует, то никаких действий не предпринимается. Если установлено в `absent` и определение присутствует, то определение пользовательского атрибута удаляется. Если установлено в `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 VMware Attribute Definition
  community.vmware.vmware_guest_custom_attribute_defs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: present
    attribute_key: custom_attr_def_1
  delegate_to: localhost
  register: defs

- name: Remove VMware Attribute Definition
  community.vmware.vmware_guest_custom_attribute_defs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    state: absent
    attribute_key: custom_attr_def_1
  delegate_to: localhost
  register: defs

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

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

Ключ	Описание
custom_attribute_defs list / elements=string	Список всех текущих определений атрибутов Возвращается: всегда Пример: `["sample_5", "sample_4"]`

Авторы

Jimmy Conner (@cigamit)
Abhijeet Kasurde (@Akasurde)

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

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