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

Новая версия с 2.7.

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

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attributes -	Значение по умолчанию: []	Список имен и значений пользовательских атрибутов, которые нужно управлять. Значение пользовательского атрибута не требуется и будет проигнорировано, если `state` установлено в `absent`.
datacenter - / обязательно		Имя центра обработки данных, в котором находится виртуальная машина.
folder -		Полный путь для поиска существующего гостевого сервера. Этот параметр является обязательным, если `name` указан и найдено несколько виртуальных машин с одинаковым именем.
hostname строка		Имя хоста или IP-адрес vCenter или сервера ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных среды добавлена в версии 2.6.
name - / обязательно		Имя виртуальной машины, с которой необходимо работать.
password строка		Пароль сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd
port целое число добавлено в 2.5	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных среды добавлена в версии 2.6.
state -	Варианты: present ← absent	Действие, которое нужно выполнить. Если установлено `present`, то пользовательский атрибут добавляется или обновляется. Если установлено `absent`, то пользовательский атрибут удаляется.
username строка		Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user
uuid -		UUID виртуальной машины для управления, если он известен. Это уникальный идентификатор VMware. Этот параметр является обязательным, если `name` не указан.
validate_certs boolean	Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в версии 2.6. Если установлено `yes`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

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

Примеры

- name: Add virtual machine custom attributes
  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
  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
  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

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

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

Ключ	Возвращаемое значение	Описание
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'}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Джимми Коннер
Абхиджей Касурде (@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.7/modules/vmware_guest_custom_attributes_module.html