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

Примечание

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

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

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

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

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
attributes список / элементы=словарь		Значение по умолчанию: []	Список имен и значений пользовательских атрибутов, которые необходимо управлять. Значение пользовательского атрибута не требуется и будет проигнорировано, если `state` установлено в `absent`.
	name строка / обязательный		Имя атрибута.
	value строка	Значение по умолчанию: ""	Значение атрибута.
datacenter строка			Имя ЦОД, в котором расположена виртуальная машина.
folder строка			Полный путь к существующей виртуальной машине. Этот параметр требуется, если `name` указан, и найдено несколько виртуальных машин с одинаковым именем.
hostname строка			Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
moid строка			Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Этот параметр необходим, если `name` или `uuid` не указаны.
name строка			Имя виртуальной машины для работы. Этот параметр необходим, если `uuid` или `moid` не указаны.
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`, то пользовательский атрибут добавляется или обновляется. Если установлено `absent`, то пользовательский атрибут удаляется.
use_instance_uuid логическое		Варианты: no ← yes	Использовать ли UUID экземпляра VMware вместо BIOS UUID.
username строка			Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
uuid строка			UUID виртуальной машины для управления, если известен. Это уникальный идентификатор VMware. Этот параметр необходим, если `name` или `moid` не указаны.
validate_certs логическое		Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в `false`, когда сертификаты не доверенны. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

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

Примеры

- name: Add virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
  delegate_to: localhost
  register: attributes

- name: Add multiple virtual machine custom attributes
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: present
    attributes:
      - name: MyAttribute
        value: MyValue
      - name: MyAttribute2
        value: MyValue2
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

- name: Remove virtual machine Attribute using Virtual Machine MoID
  community.vmware.vmware_guest_custom_attributes:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: vm-42
    state: absent
    attributes:
      - name: MyAttribute
  delegate_to: localhost
  register: attributes

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

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

Ключ	Возвращаемое значение	Описание
custom_attributes словарь	всегда	Метаданные о атрибутах виртуальной машины Пример: {'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'}

Авторы

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_attributes_module.html