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

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.6.0).

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attribute_key строка		Имя определения пользовательского атрибута. Этот параметр необходим, если `state` установлен на `present` или `absent`.
hostname строка		Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	По умолчанию: 443	Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_PORT`.
state строка	Варианты: present ← absent	Управление определением пользовательских атрибутов. Если установлено на `present`, и определение отсутствует, то пользовательское определение атрибута создается. Если установлено на `present`, и определение существует, никаких действий не выполняется. Если установлено на `absent`, и определение существует, то пользовательское определение атрибута удаляется. Если установлено на `absent`, и определение отсутствует, то никаких действий не выполняется.
username строка		Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
validate_certs булево	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается на `false`, когда сертификаты ненадёжны. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено на `true`, убедитесь, что на данном компьютере установлена Python >= 2.7.9.

Примечания

Примечание

Тестировалось на vSphere 6.5

Примеры

- 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 список / элементы=строка	всегда	список всех текущих определений атрибутов Пример: ['sample_5', 'sample_4']

Авторы

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

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